tksbrokerapi.TKSBrokerAPI

   1# -*- coding: utf-8 -*-
   2# Author: Timur Gilmullin
   3
   4"""
   5**TKSBrokerAPI** is the trading platform for automation and simplifying the implementation of trading scenarios,
   6as well as working with Tinkoff Invest API server via the REST protocol. The TKSBrokerAPI platform may be used in two ways:
   7from the console, it has a rich keys and commands, or you can use it as Python module with `python import`.
   8
   9TKSBrokerAPI allows you to automate routine trading operations and implement your trading scenarios, or just receive
  10the necessary information from the broker. It is easy enough to integrate into various CI/CD automation systems.
  11
  12- **Open account for trading:** http://tinkoff.ru/sl/AaX1Et1omnH
  13- **TKSBrokerAPI module documentation:** https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSBrokerAPI.html
  14- **See examples:** https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md#Usage-examples
  15- **Used constants are in the TKSEnums module:** https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSEnums.html
  16- **About Tinkoff Invest API:** https://tinkoff.github.io/investAPI/
  17- **Tinkoff Invest API documentation:** https://tinkoff.github.io/investAPI/swagger-ui/
  18"""
  19
  20# Copyright (c) 2022 Gilmillin Timur Mansurovich
  21#
  22# Licensed under the Apache License, Version 2.0 (the "License");
  23# you may not use this file except in compliance with the License.
  24# You may obtain a copy of the License at
  25#
  26#     http://www.apache.org/licenses/LICENSE-2.0
  27#
  28# Unless required by applicable law or agreed to in writing, software
  29# distributed under the License is distributed on an "AS IS" BASIS,
  30# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  31# See the License for the specific language governing permissions and
  32# limitations under the License.
  33
  34
  35import sys
  36import os
  37from argparse import ArgumentParser
  38from importlib.metadata import version
  39
  40from datetime import datetime, timedelta
  41from dateutil.tz import tzlocal, tzutc
  42from time import sleep
  43
  44import re
  45import json
  46import requests
  47import traceback as tb
  48from typing import Union
  49
  50from multiprocessing import cpu_count
  51from multiprocessing.pool import ThreadPool
  52import pandas as pd
  53
  54from TKSEnums import *  # A lot of constants from enums sections: https://tinkoff.github.io/investAPI/swagger-ui/
  55
  56from pricegenerator.PriceGenerator import PriceGenerator, uLogger  # This module has a lot of instruments to work with candles data. See docs here: https://github.com/Tim55667757/PriceGenerator
  57from pricegenerator.UniLogger import DisableLogger as PGDisLog  # Method for disable log from PriceGenerator
  58
  59import UniLogger as uLog  # Logger for TKSBrokerAPI
  60
  61
  62# --- Common technical parameters:
  63
  64PGDisLog(uLogger.handlers[0])  # Disable 3-rd party logging from PriceGenerator
  65uLogger = uLog.UniLogger  # init logger for TKSBrokerAPI
  66uLogger.level = 10  # debug level by default for TKSBrokerAPI module
  67uLogger.handlers[0].level = 20  # info level by default for STDOUT of TKSBrokerAPI module
  68
  69__version__ = "1.5"  # The "major.minor" version setup here, but build number define at the build-server only
  70
  71CPU_COUNT = cpu_count()  # host's real CPU count
  72CPU_USAGES = CPU_COUNT - 1 if CPU_COUNT > 1 else 1  # how many CPUs will be used for parallel calculations
  73
  74# --- Main constants:
  75
  76NANO = 0.000000001  # SI-constant nano = 10^-9
  77
  78
  79def NanoToFloat(units: str, nano: int) -> float:
  80    """
  81    Convert number in nano-view mode with string parameter `units` and integer parameter `nano` to float view. Examples:
  82
  83    `NanoToFloat(units="2", nano=500000000) -> 2.5`
  84
  85    `NanoToFloat(units="0", nano=50000000) -> 0.05`
  86
  87    :param units: integer string or integer parameter that represents the integer part of number
  88    :param nano: integer string or integer parameter that represents the fractional part of number
  89    :return: float view of number
  90    """
  91    return int(units) + int(nano) * NANO
  92
  93
  94def FloatToNano(number: float) -> dict:
  95    """
  96    Convert float number to nano-type view: dictionary with string `units` and integer `nano` parameters `{"units": "string", "nano": integer}`. Examples:
  97
  98    `FloatToNano(number=2.5) -> {"units": "2", "nano": 500000000}`
  99
 100    `FloatToNano(number=0.05) -> {"units": "0", "nano": 50000000}`
 101
 102    :param number: float number
 103    :return: nano-type view of number: `{"units": "string", "nano": integer}`
 104    """
 105    splitByPoint = str(number).split(".")
 106    frac = 0
 107
 108    if len(splitByPoint) > 1:
 109        if len(splitByPoint[1]) <= 9:
 110            frac = int("{}{}".format(
 111                int(splitByPoint[1]),
 112                "0" * (9 - len(splitByPoint[1])),
 113            ))
 114
 115    if (number < 0) and (frac > 0):
 116        frac = -frac
 117
 118    return {"units": str(int(number)), "nano": frac}
 119
 120
 121def GetDatesAsString(start: str = None, end: str = None) -> tuple:
 122    """
 123    Create tuple of date and time strings with timezone parsed from user-friendly date.
 124
 125    User dates format must be like: `%Y-%m-%d`, e.g. `2020-02-03` (3 Feb, 2020).
 126
 127    Example input: "2022-06-01" "2022-06-20" -> output: ("2022-06-01T00:00:00Z", "2022-06-20T23:59:59Z")
 128    An error exception will occur if input date has incorrect format.
 129
 130    If `start=None`, `end=None` then return dates from yesterday to the end of the day.
 131    If `start=some_date_1`, `end=None` then return dates from `some_date_1` to the end of the day.
 132    If `start=some_date_1`, `end=some_date_2` then return dates from start of `some_date_1` to end of `some_date_2`.
 133    Start day may be negative integer numbers: `-1`, `-2`, `-3` - how many days ago.
 134
 135    Also, you can use keywords for start if `end=None`:
 136    `today` (from 00:00:00 to the end of current day),
 137    `yesterday` (-1 day from 00:00:00 to 23:59:59),
 138    `week` (-7 day from 00:00:00 to the end of current day),
 139    `month` (-30 day from 00:00:00 to the end of current day),
 140    `year` (-365 day from 00:00:00 to the end of current day),
 141
 142    :return: tuple with 2 strings `(start, end)` dates in UTC ISO time format `%Y-%m-%dT%H:%M:%SZ` for OpenAPI.
 143             See date and time format here: `TKSEnums.TKS_DATE_TIME_FORMAT`.
 144             Example: `("2022-06-01T00:00:00Z", "2022-06-20T23:59:59Z")`. Second string is the end of the last day.
 145    """
 146    uLogger.debug("Input start day is [{}] (UTC), end day is [{}] (UTC)".format(start, end))
 147    s = datetime.now(tzutc()).replace(hour=0, minute=0, second=0, microsecond=0)  # start of the current day
 148    e = s.replace(hour=23, minute=59, second=59, microsecond=0)  # end of the current day
 149
 150    # time between start and the end of the current day:
 151    if start is None or start.lower() == "today":
 152        pass
 153
 154    # from start of the last day to the end of the last day:
 155    elif start.lower() == "yesterday":
 156        s -= timedelta(days=1)
 157        e -= timedelta(days=1)
 158
 159    # week (-7 day from 00:00:00 to the end of the current day):
 160    elif start.lower() == "week":
 161        s -= timedelta(days=6)  # +1 current day already taken into account
 162
 163    # month (-30 day from 00:00:00 to the end of current day):
 164    elif start.lower() == "month":
 165        s -= timedelta(days=29)  # +1 current day already taken into account
 166
 167    # year (-365 day from 00:00:00 to the end of current day):
 168    elif start.lower() == "year":
 169        s -= timedelta(days=364)  # +1 current day already taken into account
 170
 171    # -N days ago to the end of current day:
 172    elif start.startswith('-') and start[1:].isdigit():
 173        s -= timedelta(days=abs(int(start)) - 1)  # +1 current day already taken into account
 174
 175    # dates between start day at 00:00:00 and the end of the last day at 23:59:59:
 176    else:
 177        s = datetime.strptime(start, "%Y-%m-%d").replace(hour=0, minute=0, second=0, microsecond=0, tzinfo=tzutc())
 178        e = datetime.strptime(end, "%Y-%m-%d").replace(hour=23, minute=59, second=59, microsecond=0, tzinfo=tzutc()) if end is not None else e
 179
 180    # converting to UTC ISO time formatted with Z suffix for Tinkoff Open API:
 181    s = s.strftime(TKS_DATE_TIME_FORMAT)
 182    e = e.strftime(TKS_DATE_TIME_FORMAT)
 183
 184    uLogger.debug("Start day converted to UTC ISO format, with Z: [{}], and the end day: [{}]".format(s, e))
 185
 186    return s, e
 187
 188
 189class TinkoffBrokerServer:
 190    """
 191    This class implements methods to work with Tinkoff broker server.
 192
 193    Examples to work with API: https://tinkoff.github.io/investAPI/swagger-ui/
 194
 195    About `token`: https://tinkoff.github.io/investAPI/token/
 196    """
 197    def __init__(self, token: str, accountId: str = None, useCache: bool = True, defaultCache: str = "dump.json") -> None:
 198        """
 199        Main class init.
 200
 201        :param token: Bearer token for Tinkoff Invest API. It can be set from environment variable `TKS_API_TOKEN`.
 202        :param accountId: string with numeric user account ID in Tinkoff Broker. It can be found in broker's reports.
 203                          Also, this variable can be set from environment variable `TKS_ACCOUNT_ID`.
 204        :param useCache: use default cache file with raw data to use instead of `iList`.
 205                         True by default. Cache is auto-update if new day has come.
 206                         If you don't want to use cache and always updates raw data then set `useCache=False`.
 207        :param defaultCache: path to default cache file. `dump.json` by default.
 208        """
 209        if token is None or not token:
 210            try:
 211                self.token = r"{}".format(os.environ["TKS_API_TOKEN"])
 212                uLogger.debug("Bearer token for Tinkoff OpenAPI set up from environment variable `TKS_API_TOKEN`. See https://tinkoff.github.io/investAPI/token/")
 213
 214            except KeyError:
 215                uLogger.error("`--token` key or environment variable `TKS_API_TOKEN` is required! See https://tinkoff.github.io/investAPI/token/")
 216                raise Exception("Token required")
 217
 218        else:
 219            self.token = token  # highly priority than environment variable 'TKS_API_TOKEN'
 220            uLogger.debug("Bearer token for Tinkoff OpenAPI set up from class variable `token`")
 221
 222        if accountId is None or not accountId:
 223            try:
 224                self.accountId = r"{}".format(os.environ["TKS_ACCOUNT_ID"])
 225                uLogger.debug("Main account ID [{}] set up from environment variable `TKS_ACCOUNT_ID`".format(self.accountId))
 226
 227            except KeyError:
 228                uLogger.warning("`--account-id` key or environment variable `TKS_ACCOUNT_ID` undefined! Some of operations may be unavailable (overview, trading etc).")
 229
 230        else:
 231            self.accountId = accountId  # highly priority than environment variable 'TKS_ACCOUNT_ID'
 232            uLogger.debug("Main account ID [{}] set up from class variable `accountId`".format(self.accountId))
 233
 234        self.version = __version__  # duplicate here used TKSBrokerAPI main version
 235        """Current TKSBrokerAPI version: major.minor, but the build number define at the build-server only.
 236
 237        Latest version: https://pypi.org/project/tksbrokerapi/
 238        """
 239
 240        self.aliases = TKS_TICKER_ALIASES
 241        """Some aliases instead official tickers.
 242
 243        See also: `TKSEnums.TKS_TICKER_ALIASES`
 244        """
 245
 246        self.aliasesKeys = self.aliases.keys()  # re-calc only first time at class init
 247
 248        self.exclude = TKS_TICKERS_OR_FIGI_EXCLUDED  # some tickers or FIGIs raised exception earlier when it sends to server, that is why we exclude there
 249
 250        self.ticker = ""
 251        """String with ticker, e.g. `GOOGL`. Use alias for `USD000UTSTOM` simple as `USD`, `EUR_RUB__TOM` as `EUR` etc. More tickers aliases here: `TKSEnums.TKS_TICKER_ALIASES`.
 252
 253        See also: `SearchByTicker()`, `SearchInstruments()`.
 254        """
 255
 256        self.figi = ""
 257        """String with FIGI, e.g. ticker `GOOGL` has FIGI `BBG009S39JX6`.
 258
 259        See also: `SearchByFIGI()`, `SearchInstruments()`.
 260        """
 261
 262        self.depth = 1
 263        """Depth of Market (DOM) can be >= 1. Default: 1. It used with `--price` key to showing DOM with current prices for givens ticker or FIGI.
 264
 265        See also: `GetCurrentPrices()`.
 266        """
 267
 268        self.server = r"https://invest-public-api.tinkoff.ru/rest"
 269        """Tinkoff REST API server for real trade operations. Default: https://invest-public-api.tinkoff.ru/rest
 270
 271        See also: API method https://tinkoff.github.io/investAPI/#tinkoff-invest-api_1 and `SendAPIRequest()`.
 272        """
 273
 274        uLogger.debug("Broker API server: {}".format(self.server))
 275
 276        self.timeout = 15
 277        """Server operations timeout in seconds. Default: `15`.
 278
 279        See also: `SendAPIRequest()`.
 280        """
 281
 282        self.headers = {
 283            "Content-Type": "application/json",
 284            "accept": "application/json",
 285            "Authorization": "Bearer {}".format(self.token),
 286            "x-app-name": "Tim55667757.TKSBrokerAPI",
 287        }
 288        """Headers which send in every request to broker server. Please, do not change it! Default: `{"Content-Type": "application/json", "accept": "application/json", "Authorization": "Bearer {your_token}"}`.
 289
 290        See also: `SendAPIRequest()`.
 291        """
 292
 293        self.body = None
 294        """Request body which send to broker server. Default: `None`.
 295
 296        See also: `SendAPIRequest()`.
 297        """
 298
 299        self.historyFile = None
 300        """Full path to the output file where history candles will be saved or updated. Default: `None`, it mean that returns only Pandas DataFrame.
 301
 302        See also: `History()`.
 303        """
 304
 305        self.htmlHistoryFile = "index.html"
 306        """Full path to the html file where rendered candles chart stored. Default: `index.html`.
 307
 308        See also: `ShowHistoryChart()`.
 309        """
 310
 311        self.instrumentsFile = "instruments.md"
 312        """Filename where full available to user instruments list will be saved. Default: `instruments.md`.
 313
 314        See also: `ShowInstrumentsInfo()`.
 315        """
 316
 317        self.searchResultsFile = "search-results.md"
 318        """Filename with all found instruments searched by part of its ticker, FIGI or name. Default: `search-results.md`.
 319
 320        See also: `SearchInstruments()`.
 321        """
 322
 323        self.pricesFile = "prices.md"
 324        """Filename where prices of selected instruments will be saved. Default: `prices.md`.
 325
 326        See also: `GetListOfPrices()`.
 327        """
 328
 329        self.infoFile = "info.md"
 330        """Filename where prices of selected instruments will be saved. Default: `prices.md`.
 331
 332        See also: `ShowInstrumentsInfo()`, `RequestBondCoupons()` and `RequestTradingStatus()`.
 333        """
 334
 335        self.bondsXLSXFile = "ext-bonds.xlsx"
 336        """Filename where wider Pandas DataFrame with more information about bonds: main info, current prices, 
 337        bonds payment calendar, some statistics will be stored. Default: `ext-bonds.xlsx`.
 338
 339        See also: `ExtendBondsData()`.
 340        """
 341
 342        self.calendarFile = "calendar.md"
 343        """Filename where bonds payment calendar will be saved. Default: `calendar.md`.
 344        
 345        Pandas dataframe with only bonds payment calendar also will be stored to default file `calendar.xlsx`.
 346
 347        See also: `CreateBondsCalendar()`, `ShowBondsCalendar()`, `ShowInstrumentInfo()`, `RequestBondCoupons()` and `ExtendBondsData()`.
 348        """
 349
 350        self.overviewFile = "overview.md"
 351        """Filename where current portfolio, open trades and orders will be saved. Default: `overview.md`.
 352
 353        See also: `Overview()`, `RequestPortfolio()`, `RequestPositions()`, `RequestPendingOrders()` and `RequestStopOrders()`.
 354        """
 355
 356        self.overviewDigestFile = "overview-digest.md"
 357        """Filename where short digest of the portfolio status will be saved. Default: `overview-digest.md`.
 358
 359        See also: `Overview()` with parameter `details="digest"`.
 360        """
 361
 362        self.overviewPositionsFile = "overview-positions.md"
 363        """Filename where only open positions, without everything else will be saved. Default: `overview-positions.md`.
 364
 365        See also: `Overview()` with parameter `details="positions"`.
 366        """
 367
 368        self.overviewOrdersFile = "overview-orders.md"
 369        """Filename where open limits and stop orders will be saved. Default: `overview-orders.md`.
 370
 371        See also: `Overview()` with parameter `details="orders"`.
 372        """
 373
 374        self.overviewAnalyticsFile = "overview-analytics.md"
 375        """Filename where only the analytics section and the distribution of the portfolio by various categories will be saved. Default: `overview-analytics.md`.
 376
 377        See also: `Overview()` with parameter `details="analytics"`.
 378        """
 379
 380        self.reportFile = "deals.md"
 381        """Filename where history of deals and trade statistics will be saved. Default: `deals.md`.
 382
 383        See also: `Deals()`.
 384        """
 385
 386        self.withdrawalLimitsFile = "limits.md"
 387        """Filename where table of funds available for withdrawal will be saved. Default: `limits.md`.
 388
 389        See also: `OverviewLimits()` and `RequestLimits()`.
 390        """
 391
 392        self.userInfoFile = "user-info.md"
 393        """Filename where all available user's data (`accountId`s, common user information, margin status and tariff connections limit) will be saved. Default: `user-info.md`.
 394
 395        See also: `OverviewUserInfo()`, `RequestAccounts()`, `RequestUserInfo()`, `RequestMarginStatus()` and `RequestTariffLimits()`.
 396        """
 397
 398        self.userAccountsFile = "accounts.md"
 399        """Filename where simple table with all available user accounts (`accountId`s) will be saved. Default: `accounts.md`.
 400
 401        See also: `OverviewAccounts()`, `RequestAccounts()`.
 402        """
 403
 404        self.iListDumpFile = "dump.json" if defaultCache is None or not isinstance(defaultCache, str) or not defaultCache else defaultCache
 405        """Filename where raw data about shares, currencies, bonds, etfs and futures will be stored. Default: `dump.json`.
 406
 407        Pandas dataframe with raw instruments data also will be stored to default file `dump.xlsx`.
 408
 409        See also: `DumpInstruments()` and `DumpInstrumentsAsXLSX()`.
 410        """
 411
 412        self.iList = None  # init iList for raw instruments data
 413        """Dictionary with raw data about shares, currencies, bonds, etfs and futures from broker server. Auto-updating and saving dump to the `iListDumpFile`.
 414        
 415        See also: `Listing()`, `DumpInstruments()`.
 416        """
 417
 418        # trying to re-load raw instruments data from file `iListDumpFile` or try to update it from server:
 419        if useCache:
 420            if os.path.exists(self.iListDumpFile):
 421                dumpTime = datetime.fromtimestamp(os.path.getmtime(self.iListDumpFile)).astimezone(tzutc())  # dump modification date and time
 422                curTime = datetime.now(tzutc())
 423
 424                if (curTime.day > dumpTime.day) or (curTime.month > dumpTime.month) or (curTime.year > dumpTime.year):
 425                    uLogger.warning("Local cache may be outdated! It has last modified [{}] UTC. Updating from broker server, wait, please...".format(dumpTime.strftime(TKS_PRINT_DATE_TIME_FORMAT)))
 426
 427                    self.DumpInstruments(forceUpdate=True)  # updating self.iList and dump file
 428
 429                else:
 430                    self.iList = json.load(open(self.iListDumpFile, mode="r", encoding="UTF-8"))  # load iList from dump
 431
 432                    uLogger.debug("Local cache with raw instruments data is used: [{}]".format(os.path.abspath(self.iListDumpFile)))
 433                    uLogger.debug("Dump file was last modified [{}] UTC".format(dumpTime.strftime(TKS_PRINT_DATE_TIME_FORMAT)))
 434
 435            else:
 436                uLogger.warning("Local cache with raw instruments data not exists! Creating new dump, wait, please...")
 437                self.DumpInstruments(forceUpdate=True)  # updating self.iList and creating default dump file
 438
 439        else:
 440            self.iList = self.Listing()  # request new raw instruments data from broker server
 441            self.DumpInstruments(forceUpdate=False)  # save raw instrument's data to default dump file `iListDumpFile`
 442
 443        self.priceModel = PriceGenerator()  # init PriceGenerator object to work with candles data
 444        """PriceGenerator object to work with candles data: load, render interact and non-interact charts and so on.
 445
 446        See also: `LoadHistory()`, `ShowHistoryChart()` and the PriceGenerator project: https://github.com/Tim55667757/PriceGenerator
 447        """
 448
 449    @staticmethod
 450    def _ParseJSON(rawData="{}", debug: bool = False) -> dict:
 451        """
 452        Parse JSON from response string.
 453
 454        :param rawData: this is a string with JSON-formatted text.
 455        :param debug: if `True` then print more debug information.
 456        :return: JSON (dictionary), parsed from server response string.
 457        """
 458        if debug:
 459            uLogger.debug("Raw text body:")
 460            uLogger.debug(rawData)
 461
 462        responseJSON = json.loads(rawData) if rawData else {}
 463
 464        if debug:
 465            uLogger.debug("JSON formatted:")
 466            for jsonLine in json.dumps(responseJSON, indent=4).split('\n'):
 467                uLogger.debug(jsonLine)
 468
 469        return responseJSON
 470
 471    def SendAPIRequest(self, url: str, reqType: str = "GET", retry: int = 3, pause: int = 5, debug: bool = False) -> dict:
 472        """
 473        Send GET or POST request to broker server and receive JSON object.
 474
 475        self.header: must be defining with dictionary of headers.
 476        self.body: if define then used as request body. None by default.
 477        self.timeout: global request timeout, 15 seconds by default.
 478        :param url: url with REST request.
 479        :param reqType: send "GET" or "POST" request. "GET" by default.
 480        :param retry: how many times retry after first request if an 5xx server errors occurred.
 481        :param pause: sleep time in seconds between retries.
 482        :param debug: if `True` then print more debug information, e.g. request and response parameters, headers etc.
 483        :return: response JSON (dictionary) from broker.
 484        """
 485        if reqType not in ("GET", "POST"):
 486            uLogger.error("You can define request type: 'GET' or 'POST'!")
 487            raise Exception("Incorrect value")
 488
 489        if debug:
 490            uLogger.debug("Request parameters:")
 491            uLogger.debug("    - REST API URL: {}".format(url))
 492            uLogger.debug("    - request type: {}".format(reqType))
 493            uLogger.debug("    - headers: {}".format(str(self.headers).replace(self.token, "*** request token ***")))
 494            uLogger.debug("    - body: {}".format(self.body))
 495
 496        # fast hack to avoid all operations with some tickers/FIGI
 497        responseJSON = {}
 498        oK = True
 499        for item in self.exclude:
 500            if item in url:
 501                if debug:
 502                    uLogger.warning("Do not execute operations with list of this tickers/FIGI: {}".format(str(self.exclude)))
 503
 504                oK = False
 505                break
 506
 507        if oK:
 508            counter = 0
 509            response = None
 510            errMsg = ""
 511
 512            while not response and counter <= retry:
 513                if reqType == "GET":
 514                    response = requests.get(url, headers=self.headers, data=self.body, timeout=self.timeout)
 515
 516                if reqType == "POST":
 517                    response = requests.post(url, headers=self.headers, data=self.body, timeout=self.timeout)
 518
 519                if debug:
 520                    uLogger.debug("Response:")
 521                    uLogger.debug("    - status code: {}".format(response.status_code))
 522                    uLogger.debug("    - reason: {}".format(response.reason))
 523                    uLogger.debug("    - body length: {}".format(len(response.text)))
 524                    uLogger.debug("    - headers: {}".format(response.headers))
 525
 526                # Server returns some headers:
 527                # - `x-ratelimit-limit` - shows the settings of the current user limit for this method.
 528                # - `x-ratelimit-remaining` - the number of remaining requests of this type per minute.
 529                # - `x-ratelimit-reset` - time in seconds before resetting the request counter.
 530                # See: https://tinkoff.github.io/investAPI/grpc/#kreya
 531                if "x-ratelimit-remaining" in response.headers.keys() and response.headers["x-ratelimit-remaining"] == "0":
 532                    rateLimitWait = int(response.headers["x-ratelimit-reset"])
 533                    uLogger.debug("Rate limit exceeded. Waiting {} sec. for reset rate limit and then repeat again...".format(rateLimitWait))
 534                    sleep(rateLimitWait)
 535
 536                # Error status codes: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
 537                if 400 <= response.status_code < 500:
 538                    msg = "status code: [{}], response body: {}".format(response.status_code, response.text)
 539                    uLogger.debug("    - not oK, but do not retry for 4xx errors, {}".format(msg))
 540                    counter = retry + 1
 541
 542                if 500 <= response.status_code < 600:
 543                    errMsg = "status code: [{}], response body: {}".format(response.status_code, response.text)
 544                    uLogger.debug("    - not oK, {}".format(errMsg))
 545                    counter += 1
 546
 547                    if counter <= retry:
 548                        uLogger.debug("Retry: [{}]. Wait {} sec. and try again...".format(counter, pause))
 549                        sleep(pause)
 550
 551            responseJSON = self._ParseJSON(response.text)
 552
 553            if errMsg:
 554                uLogger.error("Server returns not `oK` status! See: https://tinkoff.github.io/investAPI/errors/")
 555                uLogger.error("    - not oK, {}".format(errMsg))
 556
 557        return responseJSON
 558
 559    def _IUpdater(self, iType: str) -> tuple:
 560        """
 561        Request instrument by type from server. See available API methods for instruments:
 562        Currencies: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Currencies
 563        Shares: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Shares
 564        Bonds: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Bonds
 565        Etfs: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Etfs
 566        Futures: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Futures
 567
 568        :param iType: type of the instrument, it must be one of supported types in TKS_INSTRUMENTS list.
 569        :return: tuple with iType name and list of available instruments of current type for defined user token.
 570        """
 571        result = []
 572
 573        if iType in TKS_INSTRUMENTS:
 574            uLogger.debug("Requesting available [{}] list. Wait, please...".format(iType))
 575
 576            # all instruments have the same body in API v2 requests:
 577            self.body = str({"instrumentStatus": "INSTRUMENT_STATUS_UNSPECIFIED"})  # Enum: [INSTRUMENT_STATUS_UNSPECIFIED, INSTRUMENT_STATUS_BASE, INSTRUMENT_STATUS_ALL]
 578            instrumentURL = self.server + r"/tinkoff.public.invest.api.contract.v1.InstrumentsService/{}".format(iType)
 579            result = self.SendAPIRequest(instrumentURL, reqType="POST", debug=False)["instruments"]
 580
 581        return iType, result
 582
 583    def _IWrapper(self, kwargs):
 584        """
 585        Wrapper runs instrument's update method `_IUpdater()`.
 586        It's a workaround for using multiprocessing with kwargs. See: https://stackoverflow.com/a/36799206
 587        """
 588        return self._IUpdater(**kwargs)
 589
 590    def Listing(self) -> dict:
 591        """
 592        Gets JSON with raw data about shares, currencies, bonds, etfs and futures from broker server.
 593
 594        :return: Dictionary with all available broker instruments: currencies, shares, bonds, etfs and futures.
 595        """
 596        uLogger.debug("Requesting all available instruments for current account. Wait, please...")
 597        uLogger.debug("CPU usages for parallel requests: [{}]".format(CPU_USAGES))
 598
 599        # this parameters insert to requests: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService
 600        # iType is type of instrument, it must be one of supported types in TKS_INSTRUMENTS list.
 601        iParams = [{"iType": iType} for iType in TKS_INSTRUMENTS]
 602
 603        poolUpdater = ThreadPool(processes=CPU_USAGES)  # create pool for update instruments in parallel mode
 604        listing = poolUpdater.map(self._IWrapper, iParams)  # execute update operations
 605        poolUpdater.close()
 606
 607        # Dictionary with all broker instruments: shares, currencies, bonds, etfs and futures.
 608        # Next in this code: item[0] is "iType" and item[1] is list of available instruments from the result of _IUpdater() method
 609        iList = {item[0]: {instrument["ticker"]: instrument for instrument in item[1]} for item in listing}
 610
 611        # calculate minimum price increment (step) for all instruments and set up instrument's type:
 612        for iType in iList.keys():
 613            for ticker in iList[iType]:
 614                iList[iType][ticker]["type"] = iType
 615
 616                if "minPriceIncrement" in iList[iType][ticker].keys():
 617                    iList[iType][ticker]["step"] = NanoToFloat(
 618                        iList[iType][ticker]["minPriceIncrement"]["units"],
 619                        iList[iType][ticker]["minPriceIncrement"]["nano"],
 620                    )
 621
 622                else:
 623                    iList[iType][ticker]["step"] = 0  # hack to avoid empty value in some instruments, e.g. futures
 624
 625        return iList
 626
 627    def DumpInstrumentsAsXLSX(self, forceUpdate: bool = False) -> None:
 628        """
 629        Creates XLSX-formatted dump file with raw data of instruments to further used by data scientists or stock analytics.
 630
 631        See also: `DumpInstruments()`, `Listing()`.
 632
 633        :param forceUpdate: if `True` then at first updates data with `Listing()` method,
 634                            otherwise just saves exist `iList` as XLSX-file (default: `dump.xlsx`) .
 635        """
 636        if self.iListDumpFile is None or not self.iListDumpFile:
 637            uLogger.error("Output name of dump file must be defined!")
 638            raise Exception("Filename required")
 639
 640        if not self.iList or forceUpdate:
 641            self.iList = self.Listing()
 642
 643        xlsxDumpFile = self.iListDumpFile.replace(".json", ".xlsx") if self.iListDumpFile.endswith(".json") else self.iListDumpFile + ".xlsx"
 644
 645        # Save as XLSX with separated sheets for every type of instruments:
 646        with pd.ExcelWriter(
 647                path=xlsxDumpFile,
 648                date_format=TKS_DATE_FORMAT,
 649                datetime_format=TKS_DATE_TIME_FORMAT,
 650                mode="w",
 651        ) as writer:
 652            for iType in TKS_INSTRUMENTS:
 653                df = pd.DataFrame.from_dict(data=self.iList[iType], orient="index")  # generate pandas object from self.iList dictionary
 654                df = df[sorted(df)]  # sorted by column names
 655                df = df.applymap(
 656                    lambda item: NanoToFloat(item["units"], item["nano"]) if isinstance(item, dict) and "units" in item.keys() and "nano" in item.keys() else item,
 657                    na_action="ignore",
 658                )  # converting numbers from nano-type to float in every cell
 659                df.to_excel(
 660                    writer,
 661                    sheet_name=iType,
 662                    encoding="UTF-8",
 663                    freeze_panes=(1, 1),
 664                )  # saving as XLSX-file with freeze first row and column as headers
 665
 666        uLogger.info("XLSX-file for further used by data scientists or stock analytics: [{}]".format(os.path.abspath(xlsxDumpFile)))
 667
 668    def DumpInstruments(self, forceUpdate: bool = True) -> str:
 669        """
 670        Receives and returns actual raw data about shares, currencies, bonds, etfs and futures from broker server
 671        using `Listing()` method. If `iListDumpFile` string is not empty then also save information to this file.
 672
 673        See also: `DumpInstrumentsAsXLSX()`, `Listing()`.
 674
 675        :param forceUpdate: if `True` then at first updates data with `Listing()` method,
 676                            otherwise just saves exist `iList` as JSON-file (default: `dump.json`).
 677        :return: serialized JSON formatted `str` with full data of instruments, also saved to the `--output` JSON-file.
 678        """
 679        if self.iListDumpFile is None or not self.iListDumpFile:
 680            uLogger.error("Output name of dump file must be defined!")
 681            raise Exception("Filename required")
 682
 683        if not self.iList or forceUpdate:
 684            self.iList = self.Listing()
 685
 686        jsonDump = json.dumps(self.iList, indent=4, sort_keys=False)  # create JSON object as string
 687        with open(self.iListDumpFile, mode="w", encoding="UTF-8") as fH:
 688            fH.write(jsonDump)
 689
 690        uLogger.info("New cache of instruments data was created: [{}]".format(os.path.abspath(self.iListDumpFile)))
 691
 692        return jsonDump
 693
 694    def ShowInstrumentInfo(self, iJSON: dict, show: bool = True) -> str:
 695        """
 696        Show information about one instrument defined by json data and prints it in Markdown format.
 697
 698        See also: `SearchByTicker()`, `SearchByFIGI()`, `RequestBondCoupons()`, `ExtendBondsData()`, `ShowBondsCalendar()` and `RequestTradingStatus()`.
 699
 700        :param iJSON: json data of instrument, example: `iJSON = self.iList["Shares"][self.ticker]`
 701        :param show: if `True` then also printing information about instrument and its current price.
 702        :return: multilines text in Markdown format with information about one instrument.
 703        """
 704        splitLine = "|                                                             |                                                        |\n"
 705        infoText = ""
 706
 707        if iJSON is not None and iJSON and isinstance(iJSON, dict):
 708            info = [
 709                "# Main information: ticker [{}], FIGI [{}]\n\n".format(iJSON["ticker"], iJSON["figi"]),
 710                "* Actual at: [{}] (UTC)\n\n".format(datetime.now(tzutc()).strftime("%Y-%m-%d %H:%M")),
 711                "| Parameters                                                  | Values                                                 |\n",
 712                "|-------------------------------------------------------------|--------------------------------------------------------|\n",
 713                "| Ticker:                                                     | {:<54} |\n".format(iJSON["ticker"]),
 714                "| Full name:                                                  | {:<54} |\n".format(iJSON["name"]),
 715            ]
 716
 717            if "sector" in iJSON.keys() and iJSON["sector"]:
 718                info.append("| Sector:                                                     | {:<54} |\n".format(iJSON["sector"]))
 719
 720            info.append("| Country of instrument:                                      | {:<54} |\n".format("{}{}".format(
 721                "({}) ".format(iJSON["countryOfRisk"]) if "countryOfRisk" in iJSON.keys() and iJSON["countryOfRisk"] else "",
 722                iJSON["countryOfRiskName"] if "countryOfRiskName" in iJSON.keys() and iJSON["countryOfRiskName"] else "",
 723            )))
 724
 725            info.extend([
 726                splitLine,
 727                "| FIGI (Financial Instrument Global Identifier):              | {:<54} |\n".format(iJSON["figi"]),
 728                "| Exchange:                                                   | {:<54} |\n".format(iJSON["exchange"]),
 729            ])
 730
 731            if "isin" in iJSON.keys() and iJSON["isin"]:
 732                info.append("| ISIN (International Securities Identification Number):      | {:<54} |\n".format(iJSON["isin"]))
 733
 734            if "classCode" in iJSON.keys():
 735                info.append("| Class Code (exchange section where instrument is traded):   | {:<54} |\n".format(iJSON["classCode"]))
 736
 737            info.extend([
 738                splitLine,
 739                "| Current broker security trading status:                     | {:<54} |\n".format(TKS_TRADING_STATUSES[iJSON["tradingStatus"]]),
 740                splitLine,
 741                "| Buy operations allowed:                                     | {:<54} |\n".format("Yes" if iJSON["buyAvailableFlag"] else "No"),
 742                "| Sale operations allowed:                                    | {:<54} |\n".format("Yes" if iJSON["sellAvailableFlag"] else "No"),
 743                "| Short positions allowed:                                    | {:<54} |\n".format("Yes" if iJSON["shortEnabledFlag"] else "No"),
 744            ])
 745
 746            if iJSON["figi"]:
 747                self.figi = iJSON["figi"]
 748                iJSON = iJSON | self.RequestTradingStatus()
 749
 750                info.extend([
 751                    splitLine,
 752                    "| Limit orders allowed:                                       | {:<54} |\n".format("Yes" if iJSON["limitOrderAvailableFlag"] else "No"),
 753                    "| Market orders allowed:                                      | {:<54} |\n".format("Yes" if iJSON["marketOrderAvailableFlag"] else "No"),
 754                    "| API trade allowed:                                          | {:<54} |\n".format("Yes" if iJSON["apiTradeAvailableFlag"] else "No"),
 755                ])
 756
 757            info.append(splitLine)
 758
 759            if "type" in iJSON.keys() and iJSON["type"]:
 760                info.append("| Type of the instrument:                                     | {:<54} |\n".format(iJSON["type"]))
 761
 762            if "futuresType" in iJSON.keys() and iJSON["futuresType"]:
 763                info.append("| Futures type:                                               | {:<54} |\n".format(iJSON["futuresType"]))
 764
 765            if "ipoDate" in iJSON.keys() and iJSON["ipoDate"]:
 766                info.append("| IPO date:                                                   | {:<54} |\n".format(iJSON["ipoDate"].replace("T", " ").replace("Z", "")))
 767
 768            if "releasedDate" in iJSON.keys() and iJSON["releasedDate"]:
 769                info.append("| Released date:                                              | {:<54} |\n".format(iJSON["releasedDate"].replace("T", " ").replace("Z", "")))
 770
 771            if "rebalancingFreq" in iJSON.keys() and iJSON["rebalancingFreq"]:
 772                info.append("| Rebalancing frequency:                                      | {:<54} |\n".format(iJSON["rebalancingFreq"]))
 773
 774            if "focusType" in iJSON.keys() and iJSON["focusType"]:
 775                info.append("| Focusing type:                                              | {:<54} |\n".format(iJSON["focusType"]))
 776
 777            if "assetType" in iJSON.keys() and iJSON["assetType"]:
 778                info.append("| Asset type:                                                 | {:<54} |\n".format(iJSON["assetType"]))
 779
 780            if "basicAsset" in iJSON.keys() and iJSON["basicAsset"]:
 781                info.append("| Basic asset:                                                | {:<54} |\n".format(iJSON["basicAsset"]))
 782
 783            if "basicAssetSize" in iJSON.keys() and iJSON["basicAssetSize"]:
 784                info.append("| Basic asset size:                                           | {:<54} |\n".format("{:.2f}".format(NanoToFloat(str(iJSON["basicAssetSize"]["units"]), iJSON["basicAssetSize"]["nano"]))))
 785
 786            if "isoCurrencyName" in iJSON.keys() and iJSON["isoCurrencyName"]:
 787                info.append("| ISO currency name:                                          | {:<54} |\n".format(iJSON["isoCurrencyName"]))
 788
 789            if "currency" in iJSON.keys():
 790                info.append("| Payment currency:                                           | {:<54} |\n".format(iJSON["currency"]))
 791
 792            if iJSON["type"] == "Bonds" and "nominal" in iJSON.keys() and "currency" in iJSON["nominal"].keys():
 793                info.append("| Nominal currency:                                           | {:<54} |\n".format(iJSON["nominal"]["currency"]))
 794
 795            if "firstTradeDate" in iJSON.keys() and iJSON["firstTradeDate"]:
 796                info.append("| First trade date:                                           | {:<54} |\n".format(iJSON["firstTradeDate"].replace("T", " ").replace("Z", "")))
 797
 798            if "lastTradeDate" in iJSON.keys() and iJSON["lastTradeDate"]:
 799                info.append("| Last trade date:                                            | {:<54} |\n".format(iJSON["lastTradeDate"].replace("T", " ").replace("Z", "")))
 800
 801            if "expirationDate" in iJSON.keys() and iJSON["expirationDate"]:
 802                info.append("| Date of expiration:                                         | {:<54} |\n".format(iJSON["expirationDate"].replace("T", " ").replace("Z", "")))
 803
 804            if "stateRegDate" in iJSON.keys() and iJSON["stateRegDate"]:
 805                info.append("| State registration date:                                    | {:<54} |\n".format(iJSON["stateRegDate"].replace("T", " ").replace("Z", "")))
 806
 807            if "placementDate" in iJSON.keys() and iJSON["placementDate"]:
 808                info.append("| Placement date:                                             | {:<54} |\n".format(iJSON["placementDate"].replace("T", " ").replace("Z", "")))
 809
 810            if "maturityDate" in iJSON.keys() and iJSON["maturityDate"]:
 811                info.append("| Maturity date:                                              | {:<54} |\n".format(iJSON["maturityDate"].replace("T", " ").replace("Z", "")))
 812
 813            if "perpetualFlag" in iJSON.keys() and iJSON["perpetualFlag"]:
 814                info.append("| Perpetual bond:                                             | Yes                                                    |\n")
 815
 816            if "otcFlag" in iJSON.keys() and iJSON["otcFlag"]:
 817                info.append("| Over-the-counter (OTC) securities:                          | Yes                                                    |\n")
 818
 819            iExt = None
 820            if iJSON["type"] == "Bonds":
 821                info.extend([
 822                    splitLine,
 823                    "| Bond issue (size / plan):                                   | {:<54} |\n".format("{} / {}".format(iJSON["issueSize"], iJSON["issueSizePlan"])),
 824                    "| Nominal price (100%):                                       | {:<54} |\n".format("{} {}".format(
 825                        "{:.2f}".format(NanoToFloat(str(iJSON["nominal"]["units"]), iJSON["nominal"]["nano"])).rstrip("0").rstrip("."),
 826                        iJSON["nominal"]["currency"],
 827                    )),
 828                ])
 829
 830                if "floatingCouponFlag" in iJSON.keys():
 831                    info.append("| Floating coupon:                                            | {:<54} |\n".format("Yes" if iJSON["floatingCouponFlag"] else "No"))
 832
 833                if "amortizationFlag" in iJSON.keys():
 834                    info.append("| Amortization:                                               | {:<54} |\n".format("Yes" if iJSON["amortizationFlag"] else "No"))
 835
 836                info.append(splitLine)
 837
 838                if "couponQuantityPerYear" in iJSON.keys() and iJSON["couponQuantityPerYear"]:
 839                    info.append("| Number of coupon payments per year:                         | {:<54} |\n".format(iJSON["couponQuantityPerYear"]))
 840
 841                iExt = self.ExtendBondsData(instruments=iJSON["figi"], xlsx=False)  # extended bonds data
 842
 843                info.extend([
 844                    "| Days last to maturity date:                                 | {:<54} |\n".format(iExt["daysToMaturity"][0]),
 845                    "| Coupons yield (average coupon daily yield * 365):           | {:<54} |\n".format("{:.2f}%".format(iExt["couponsYield"][0])),
 846                    "| Current price yield (average daily yield * 365):            | {:<54} |\n".format("{:.2f}%".format(iExt["currentYield"][0])),
 847                ])
 848
 849                if "aciValue" in iJSON.keys() and iJSON["aciValue"]:
 850                    info.append("| Current accumulated coupon income (ACI):                    | {:<54} |\n".format("{:.2f} {}".format(
 851                        NanoToFloat(str(iJSON["aciValue"]["units"]), iJSON["aciValue"]["nano"]),
 852                        iJSON["aciValue"]["currency"]
 853                    )))
 854
 855            if "currentPrice" in iJSON.keys():
 856                info.append(splitLine)
 857
 858                currency = iJSON["currency"] if "currency" in iJSON.keys() else ""  # nominal currency for bonds, otherwise currency of instrument
 859                aciCurrency = iExt["aciCurrency"][0] if iJSON["type"] == "Bonds" and iExt is not None and "aciCurrency" in iExt.keys() else ""  # payment currency
 860
 861                bondPrevClose = iExt["closePrice"][0] if iJSON["type"] == "Bonds" and iExt is not None and "closePrice" in iExt.keys() else 0  # previous close price of bond
 862                bondLastPrice = iExt["lastPrice"][0] if iJSON["type"] == "Bonds" and iExt is not None and "lastPrice" in iExt.keys() else 0  # last price of bond
 863                bondLimitUp = iExt["limitUp"][0] if iJSON["type"] == "Bonds" and iExt is not None and "limitUp" in iExt.keys() else 0  # max price of bond
 864                bondLimitDown = iExt["limitDown"][0] if iJSON["type"] == "Bonds" and iExt is not None and "limitDown" in iExt.keys() else 0  # min price of bond
 865                bondChangesDelta = iExt["changesDelta"][0] if iJSON["type"] == "Bonds" and iExt is not None and "changesDelta" in iExt.keys() else 0  # delta between last deal price and last close
 866
 867                curPriceSell = iJSON["currentPrice"]["sell"][0]["price"] if iJSON["currentPrice"]["sell"] else 0
 868                curPriceBuy = iJSON["currentPrice"]["buy"][0]["price"] if iJSON["currentPrice"]["buy"] else 0
 869
 870                info.extend([
 871                    "| Previous close price of the instrument:                     | {:<54} |\n".format("{}{}".format(
 872                        "{}".format(iJSON["currentPrice"]["closePrice"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["closePrice"] is not None else "N/A",
 873                        "% of nominal price ({:.2f} {})".format(bondPrevClose, aciCurrency) if iJSON["type"] == "Bonds" else " {}".format(currency),
 874                    )),
 875                    "| Last deal price of the instrument:                          | {:<54} |\n".format("{}{}".format(
 876                        "{}".format(iJSON["currentPrice"]["lastPrice"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["lastPrice"] is not None else "N/A",
 877                        "% of nominal price ({:.2f} {})".format(bondLastPrice, aciCurrency) if iJSON["type"] == "Bonds" else " {}".format(currency),
 878                    )),
 879                    "| Changes between last deal price and last close              | {:<54} |\n".format(
 880                        "{:.2f}%{}".format(
 881                            iJSON["currentPrice"]["changes"],
 882                            " ({}{:.2f} {})".format(
 883                                "+" if bondChangesDelta > 0 else "",
 884                                bondChangesDelta,
 885                                aciCurrency
 886                            ) if iJSON["type"] == "Bonds" else " ({}{:.2f} {})".format(
 887                                "+" if iJSON["currentPrice"]["lastPrice"] > iJSON["currentPrice"]["closePrice"] else "",
 888                                iJSON["currentPrice"]["lastPrice"] - iJSON["currentPrice"]["closePrice"],
 889                                currency
 890                            ),
 891                        )
 892                    ),
 893                    "| Current limit price, min / max:                             | {:<54} |\n".format("{}{} / {}{}{}".format(
 894                        "{}".format(iJSON["currentPrice"]["limitDown"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["limitDown"] is not None else "N/A",
 895                        "%" if iJSON["type"] == "Bonds" else " {}".format(currency),
 896                        "{}".format(iJSON["currentPrice"]["limitUp"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["limitUp"] is not None else "N/A",
 897                        "%" if iJSON["type"] == "Bonds" else " {}".format(currency),
 898                        " ({:.2f} {} / {:.2f} {})".format(bondLimitDown, aciCurrency, bondLimitUp, aciCurrency) if iJSON["type"] == "Bonds" else ""
 899                    )),
 900                    "| Actual price, sell / buy:                                   | {:<54} |\n".format("{}{} / {}{}{}".format(
 901                        "{}".format(curPriceSell).rstrip("0").rstrip(".") if curPriceSell != 0 else "N/A",
 902                        "%" if iJSON["type"] == "Bonds" else " {}".format(currency),
 903                        "{}".format(curPriceBuy).rstrip("0").rstrip(".") if curPriceBuy != 0 else "N/A",
 904                        "%" if iJSON["type"] == "Bonds" else" {}".format(currency),
 905                        " ({:.2f} {} / {:.2f} {})".format(curPriceSell, aciCurrency, curPriceBuy, aciCurrency) if iJSON["type"] == "Bonds" else ""
 906                    )),
 907                ])
 908
 909            if "lot" in iJSON.keys():
 910                info.append("| Minimum lot to buy:                                         | {:<54} |\n".format(iJSON["lot"]))
 911
 912            if "step" in iJSON.keys() and iJSON["step"] != 0:
 913                info.append("| Minimum price increment (step):                             | {:<54} |\n".format(iJSON["step"]))
 914
 915            # Add bond payment calendar:
 916            if iJSON["type"] == "Bonds":
 917                strCalendar = self.ShowBondsCalendar(extBonds=iExt, show=False)   # bond payment calendar
 918                info.extend(["\n", strCalendar])
 919
 920            infoText += "".join(info)
 921
 922            if show:
 923                uLogger.info("{}".format(infoText))
 924
 925            else:
 926                uLogger.debug("{}".format(infoText))
 927
 928            if self.infoFile is not None:
 929                with open(self.infoFile, "w", encoding="UTF-8") as fH:
 930                    fH.write(infoText)
 931
 932                uLogger.info("Info about instrument with ticker [{}] and FIGI [{}] was saved to file: [{}]".format(iJSON["ticker"], iJSON["figi"], os.path.abspath(self.infoFile)))
 933
 934        return infoText
 935
 936    def SearchByTicker(self, requestPrice: bool = False, show: bool = False, debug: bool = False) -> dict:
 937        """
 938        Search and return raw broker's information about instrument by its ticker.
 939        `ticker` must be defined! If debug=True then print all debug messages.
 940
 941        :param requestPrice: if `False` then do not request current price of instrument (because this is long operation).
 942        :param show: if `False` then do not run `ShowInstrumentInfo()` method and do not print info to the console.
 943        :param debug: if `True` then print all debug console messages.
 944        :return: JSON formatted data with information about instrument.
 945        """
 946        tickerJSON = {}
 947        if debug:
 948            uLogger.debug("Searching information about instrument by it's ticker [{}] ...".format(self.ticker))
 949
 950        if not self.ticker:
 951            uLogger.warning("self.ticker variable is not be empty!")
 952
 953        else:
 954            if self.ticker in TKS_TICKERS_OR_FIGI_EXCLUDED:
 955                uLogger.warning("Instrument with ticker [{}] not allowed for trading!".format(self.ticker))
 956                raise Exception("Instrument not allowed")
 957
 958            if not self.iList:
 959                self.iList = self.Listing()
 960
 961            if self.ticker in self.iList["Shares"].keys():
 962                tickerJSON = self.iList["Shares"][self.ticker]
 963                if debug:
 964                    uLogger.debug("Ticker [{}] found in shares list".format(self.ticker))
 965
 966            elif self.ticker in self.iList["Currencies"].keys():
 967                tickerJSON = self.iList["Currencies"][self.ticker]
 968                if debug:
 969                    uLogger.debug("Ticker [{}] found in currencies list".format(self.ticker))
 970
 971            elif self.ticker in self.iList["Bonds"].keys():
 972                tickerJSON = self.iList["Bonds"][self.ticker]
 973                if debug:
 974                    uLogger.debug("Ticker [{}] found in bonds list".format(self.ticker))
 975
 976            elif self.ticker in self.iList["Etfs"].keys():
 977                tickerJSON = self.iList["Etfs"][self.ticker]
 978                if debug:
 979                    uLogger.debug("Ticker [{}] found in etfs list".format(self.ticker))
 980
 981            elif self.ticker in self.iList["Futures"].keys():
 982                tickerJSON = self.iList["Futures"][self.ticker]
 983                if debug:
 984                    uLogger.debug("Ticker [{}] found in futures list".format(self.ticker))
 985
 986        if tickerJSON:
 987            self.figi = tickerJSON["figi"]
 988
 989            if requestPrice:
 990                tickerJSON["currentPrice"] = self.GetCurrentPrices(show=False)
 991
 992                if tickerJSON["currentPrice"]["closePrice"] is not None and tickerJSON["currentPrice"]["closePrice"] != 0 and tickerJSON["currentPrice"]["lastPrice"] is not None:
 993                    tickerJSON["currentPrice"]["changes"] = 100 * (tickerJSON["currentPrice"]["lastPrice"] - tickerJSON["currentPrice"]["closePrice"]) / tickerJSON["currentPrice"]["closePrice"]
 994
 995                else:
 996                    tickerJSON["currentPrice"]["changes"] = 0
 997
 998            if show:
 999                self.ShowInstrumentInfo(iJSON=tickerJSON, show=True)  # print info as Markdown text
1000
1001        else:
1002            if show:
1003                uLogger.warning("Ticker [{}] not found in available broker instrument's list!".format(self.ticker))
1004
1005        return tickerJSON
1006
1007    def SearchByFIGI(self, requestPrice: bool = False, show: bool = False, debug: bool = False) -> dict:
1008        """
1009        Search and return raw broker's information about instrument by its FIGI.
1010        `figi` must be defined! If debug=True then print all debug messages.
1011
1012        :param requestPrice: if `False` then do not request current price of instrument (it's long operation).
1013        :param show: if `False` then do not run `ShowInstrumentInfo()` method and do not print info to the console.
1014        :param debug: if `True` then print all debug console messages.
1015        :return: JSON formatted data with information about instrument.
1016        """
1017        figiJSON = {}
1018        if debug:
1019            uLogger.debug("Searching information about instrument by it's FIGI [{}] ...".format(self.figi))
1020
1021        if not self.figi:
1022            uLogger.warning("self.figi variable is not be empty!")
1023
1024        else:
1025            if self.figi in TKS_TICKERS_OR_FIGI_EXCLUDED:
1026                uLogger.warning("Instrument with figi [{}] not allowed for trading!".format(self.figi))
1027                raise Exception("Instrument not allowed")
1028
1029            if not self.iList:
1030                self.iList = self.Listing()
1031
1032            for item in self.iList["Shares"].keys():
1033                if self.figi == self.iList["Shares"][item]["figi"]:
1034                    figiJSON = self.iList["Shares"][item]
1035
1036                    if debug:
1037                        uLogger.debug("FIGI [{}] found in shares list".format(self.figi))
1038
1039                    break
1040
1041            if not figiJSON:
1042                for item in self.iList["Currencies"].keys():
1043                    if self.figi == self.iList["Currencies"][item]["figi"]:
1044                        figiJSON = self.iList["Currencies"][item]
1045
1046                        if debug:
1047                            uLogger.debug("FIGI [{}] found in currencies list".format(self.figi))
1048
1049                        break
1050
1051            if not figiJSON:
1052                for item in self.iList["Bonds"].keys():
1053                    if self.figi == self.iList["Bonds"][item]["figi"]:
1054                        figiJSON = self.iList["Bonds"][item]
1055
1056                        if debug:
1057                            uLogger.debug("FIGI [{}] found in bonds list".format(self.figi))
1058
1059                        break
1060
1061            if not figiJSON:
1062                for item in self.iList["Etfs"].keys():
1063                    if self.figi == self.iList["Etfs"][item]["figi"]:
1064                        figiJSON = self.iList["Etfs"][item]
1065
1066                        if debug:
1067                            uLogger.debug("FIGI [{}] found in etfs list".format(self.figi))
1068
1069                        break
1070
1071            if not figiJSON:
1072                for item in self.iList["Futures"].keys():
1073                    if self.figi == self.iList["Futures"][item]["figi"]:
1074                        figiJSON = self.iList["Futures"][item]
1075
1076                        if debug:
1077                            uLogger.debug("FIGI [{}] found in futures list".format(self.figi))
1078
1079                        break
1080
1081        if figiJSON:
1082            self.figi = figiJSON["figi"]
1083            self.ticker = figiJSON["ticker"]
1084
1085            if requestPrice:
1086                figiJSON["currentPrice"] = self.GetCurrentPrices(show=False)
1087
1088                if figiJSON["currentPrice"]["closePrice"] is not None and figiJSON["currentPrice"]["closePrice"] != 0 and figiJSON["currentPrice"]["lastPrice"] is not None:
1089                    figiJSON["currentPrice"]["changes"] = 100 * (figiJSON["currentPrice"]["lastPrice"] - figiJSON["currentPrice"]["closePrice"]) / figiJSON["currentPrice"]["closePrice"]
1090
1091                else:
1092                    figiJSON["currentPrice"]["changes"] = 0
1093
1094            if show:
1095                self.ShowInstrumentInfo(iJSON=figiJSON, show=True)  # print info as Markdown text
1096
1097        else:
1098            if show:
1099                uLogger.warning("FIGI [{}] not found in available broker instrument's list!".format(self.figi))
1100
1101        return figiJSON
1102
1103    def GetCurrentPrices(self, show: bool = True) -> dict:
1104        """
1105        Get and show Depth of Market with current prices of the instrument as dictionary. Result example with `depth` 5:
1106        `{"buy": [{"price": 1243.8, "quantity": 193},
1107                  {"price": 1244.0, "quantity": 168},
1108                  {"price": 1244.8, "quantity": 5},
1109                  {"price": 1245.0, "quantity": 61},
1110                  {"price": 1245.4, "quantity": 60}],
1111          "sell": [{"price": 1243.6, "quantity": 8},
1112                   {"price": 1242.6, "quantity": 10},
1113                   {"price": 1242.4, "quantity": 18},
1114                   {"price": 1242.2, "quantity": 50},
1115                   {"price": 1242.0, "quantity": 113}],
1116          "limitUp": 1619.0, "limitDown": 903.4, "lastPrice": 1243.8, "closePrice": 1263.0}`, where parameters mean:
1117        - buy: list of dicts with Sellers prices, see also: https://tinkoff.github.io/investAPI/marketdata/#order
1118        - sell: list of dicts with Buyers prices,
1119            - price: price of 1 instrument (to get the cost of the lot, you need to multiply it by the lot of size of the instrument),
1120            - quantity: volume value by current price in lots,
1121        - limitUp: current trade session limit price, maximum,
1122        - limitDown: current trade session limit price, minimum,
1123        - lastPrice: last deal price of the instrument,
1124        - closePrice: previous trade session close price of the instrument.
1125
1126        See also: `SearchByTicker()` and `SearchByFIGI()`.
1127        REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetOrderBook
1128        Response fields: https://tinkoff.github.io/investAPI/marketdata/#getorderbookresponse
1129
1130        :param show: if `True` then print DOM to log and console.
1131        :return: orders book dict with lists of current buy and sell prices: `{"buy": [{"price": x1, "quantity": y1, ...}], "sell": [....]}`.
1132                 If an error occurred then returns an empty record:
1133                 `{"buy": [], "sell": [], "limitUp": None, "limitDown": None, "lastPrice": None, "closePrice": None}`.
1134        """
1135        prices = {"buy": [], "sell": [], "limitUp": 0, "limitDown": 0, "lastPrice": 0, "closePrice": 0}
1136
1137        if self.depth < 1:
1138            uLogger.error("Depth of Market (DOM) must be >=1!")
1139            raise Exception("Incorrect value")
1140
1141        if not (self.ticker or self.figi):
1142            uLogger.error("self.ticker or self.figi variables must be defined!")
1143            raise Exception("Ticker or FIGI required")
1144
1145        if self.ticker and not self.figi:
1146            instrumentByTicker = self.SearchByTicker(requestPrice=False)  # WARNING! requestPrice=False to avoid recursion!
1147            self.figi = instrumentByTicker["figi"] if instrumentByTicker else ""
1148
1149        if not self.ticker and self.figi:
1150            instrumentByFigi = self.SearchByFIGI(requestPrice=False)  # WARNING! requestPrice=False to avoid recursion!
1151            self.ticker = instrumentByFigi["ticker"] if instrumentByFigi else ""
1152
1153        if not self.figi:
1154            uLogger.error("FIGI is not defined!")
1155            raise Exception("Ticker or FIGI required")
1156
1157        else:
1158            uLogger.debug("Requesting current prices: ticker [{}], FIGI [{}]. Wait, please...".format(self.ticker, self.figi))
1159
1160            # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetOrderBook
1161            priceURL = self.server + r"/tinkoff.public.invest.api.contract.v1.MarketDataService/GetOrderBook"
1162            self.body = str({"figi": self.figi, "depth": self.depth})
1163            pricesResponse = self.SendAPIRequest(priceURL, reqType="POST")  # Response fields: https://tinkoff.github.io/investAPI/marketdata/#getorderbookresponse
1164
1165            if pricesResponse:
1166                # list of dicts with sellers orders:
1167                prices["buy"] = [{"price": round(NanoToFloat(item["price"]["units"], item["price"]["nano"]), 6), "quantity": int(item["quantity"])} for item in pricesResponse["asks"]]
1168
1169                # list of dicts with buyers orders:
1170                prices["sell"] = [{"price": round(NanoToFloat(item["price"]["units"], item["price"]["nano"]), 6), "quantity": int(item["quantity"])} for item in pricesResponse["bids"]]
1171
1172                # max price of instrument at this time:
1173                prices["limitUp"] = round(NanoToFloat(pricesResponse["limitUp"]["units"], pricesResponse["limitUp"]["nano"]), 6) if "limitUp" in pricesResponse.keys() else None
1174
1175                # min price of instrument at this time:
1176                prices["limitDown"] = round(NanoToFloat(pricesResponse["limitDown"]["units"], pricesResponse["limitDown"]["nano"]), 6) if "limitDown" in pricesResponse.keys() else None
1177
1178                # last price of deal with instrument:
1179                prices["lastPrice"] = round(NanoToFloat(pricesResponse["lastPrice"]["units"], pricesResponse["lastPrice"]["nano"]), 6) if "lastPrice" in pricesResponse.keys() else 0
1180
1181                # last close price of instrument:
1182                prices["closePrice"] = round(NanoToFloat(pricesResponse["closePrice"]["units"], pricesResponse["closePrice"]["nano"]), 6) if "closePrice" in pricesResponse.keys() else 0
1183
1184            else:
1185                uLogger.warning("Server return an empty or error response! See full log. Instrument: ticker [{}], FIGI [{}]".format(self.ticker, self.figi))
1186                uLogger.debug("Server response: {}".format(pricesResponse))
1187
1188            if show:
1189                if prices["buy"] or prices["sell"]:
1190                    info = [
1191                        "Orders book actual at [{}] (UTC)\nTicker: [{}], FIGI: [{}], Depth of Market: [{}]\n".format(
1192                            datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
1193                            self.ticker,
1194                            self.figi,
1195                            self.depth,
1196                        ),
1197                        "-" * 60, "\n",
1198                        "             Orders of Buyers | Orders of Sellers\n",
1199                        "-" * 60, "\n",
1200                        "        Sell prices (volumes) | Buy prices (volumes)\n",
1201                        "-" * 60, "\n",
1202                    ]
1203
1204                    if not prices["buy"]:
1205                        info.append("                              | No orders!\n")
1206                        sumBuy = 0
1207
1208                    else:
1209                        sumBuy = sum([x["quantity"] for x in prices["buy"]])
1210                        maxMinSorted = sorted(prices["buy"], key=lambda k: k["price"], reverse=True)
1211                        for item in maxMinSorted:
1212                            info.append("                              | {} ({})\n".format(item["price"], item["quantity"]))
1213
1214                    if not prices["sell"]:
1215                        info.append("No orders!                    |\n")
1216                        sumSell = 0
1217
1218                    else:
1219                        sumSell = sum([x["quantity"] for x in prices["sell"]])
1220                        for item in prices["sell"]:
1221                            info.append("{:>29} |\n".format("{} ({})".format(item["price"], item["quantity"])))
1222
1223                    info.extend([
1224                        "-" * 60, "\n",
1225                        "{:>29} | {}\n".format("Total sell: {}".format(sumSell), "Total buy: {}".format(sumBuy)),
1226                        "-" * 60, "\n",
1227                    ])
1228
1229                    infoText = "".join(info)
1230
1231                    uLogger.info("Current prices in order book:\n\n{}".format(infoText))
1232
1233                else:
1234                    uLogger.warning("Orders book is empty at this time! Instrument: ticker [{}], FIGI [{}]".format(self.ticker, self.figi))
1235
1236        return prices
1237
1238    def ShowInstrumentsInfo(self, show: bool = True) -> str:
1239        """
1240        This method get and show information about all available broker instruments for current user account.
1241        If `instrumentsFile` string is not empty then also save information to this file.
1242
1243        :param show: if `True` then print results to console, if `False` - print only to file.
1244        :return: multi-lines string with all available broker instruments
1245        """
1246        if not self.iList:
1247            self.iList = self.Listing()
1248
1249        info = [
1250            "# All available instruments from Tinkoff Broker server for current user token\n\n",
1251            "* **Actual on date:** [{} UTC]\n".format(datetime.now(tzutc()).strftime("%Y-%m-%d %H:%M")),
1252        ]
1253
1254        # add instruments count by type:
1255        for iType in self.iList.keys():
1256            info.append("* **{}:** [{}]\n".format(iType, len(self.iList[iType])))
1257
1258        headerLine = "| Ticker       | Full name                                                 | FIGI         | Cur | Lot     | Step       |\n"
1259        splitLine = "|--------------|-----------------------------------------------------------|--------------|-----|---------|------------|\n"
1260
1261        # generating info tables with all instruments by type:
1262        for iType in self.iList.keys():
1263            info.extend(["\n\n## {} available. Total: [{}]\n\n".format(iType, len(self.iList[iType])), headerLine, splitLine])
1264
1265            for instrument in self.iList[iType].keys():
1266                iName = self.iList[iType][instrument]["name"]  # instrument's name
1267                if len(iName) > 57:
1268                    iName = "{}...".format(iName[:54])  # right trim for a long string
1269
1270                info.append("| {:<12} | {:<57} | {:<12} | {:<3} | {:<7} | {:<10} |\n".format(
1271                    self.iList[iType][instrument]["ticker"],
1272                    iName,
1273                    self.iList[iType][instrument]["figi"],
1274                    self.iList[iType][instrument]["currency"],
1275                    self.iList[iType][instrument]["lot"],
1276                    "{:.10f}".format(self.iList[iType][instrument]["step"]).rstrip("0").rstrip(".") if self.iList[iType][instrument]["step"] > 0 else 0,
1277                ))
1278
1279        infoText = "".join(info)
1280
1281        if show:
1282            uLogger.info(infoText)
1283
1284        if self.instrumentsFile:
1285            with open(self.instrumentsFile, "w", encoding="UTF-8") as fH:
1286                fH.write(infoText)
1287
1288            uLogger.info("All available instruments are saved to file: [{}]".format(os.path.abspath(self.instrumentsFile)))
1289
1290        return infoText
1291
1292    def SearchInstruments(self, pattern: str, show: bool = True) -> dict:
1293        """
1294        This method search and show information about instruments by part of its ticker, FIGI or name.
1295        If `searchResultsFile` string is not empty then also save information to this file.
1296
1297        :param pattern: string with part of ticker, FIGI or instrument's name.
1298        :param show: if `True` then print results to console, if `False` - return list of result only.
1299        :return: list of dictionaries with all found instruments.
1300        """
1301        if not self.iList:
1302            self.iList = self.Listing()
1303
1304        searchResults = {iType: {} for iType in self.iList}  # same as iList but will contains only filtered instruments
1305        compiledPattern = re.compile(pattern, re.IGNORECASE)
1306
1307        for iType in self.iList:
1308            for instrument in self.iList[iType].values():
1309                searchResult = compiledPattern.search(" ".join(
1310                    [instrument["ticker"], instrument["figi"], instrument["name"]]
1311                ))
1312
1313                if searchResult:
1314                    searchResults[iType][instrument["ticker"]] = instrument
1315
1316        resultsLen = sum([len(searchResults[iType]) for iType in searchResults])
1317        info = [
1318            "# Search results\n\n",
1319            "* **Search pattern:** [{}]\n".format(pattern),
1320            "* **Found instruments:** [{}]\n\n".format(resultsLen),
1321            "**Note:** you can view info about found instruments with key `--info`, e.g.: `tksbrokerapi -t TICKER --info` or `tksbrokerapi -f FIGI --info`.\n"
1322        ]
1323        infoShort = info[:]
1324
1325        headerLine = "| Type       | Ticker       | Full name                                                      | FIGI         |\n"
1326        splitLine = "|------------|--------------|----------------------------------------------------------------|--------------|\n"
1327        skippedLine = "| ...        | ...          | ...                                                            | ...          |\n"
1328
1329        if resultsLen == 0:
1330            info.append("\nNo results\n")
1331            infoShort.append("\nNo results\n")
1332            uLogger.warning("No results. Try changing your search pattern.")
1333
1334        else:
1335            for iType in searchResults:
1336                iTypeValuesCount = len(searchResults[iType].values())
1337                if iTypeValuesCount > 0:
1338                    info.extend(["\n### {}: [{}]\n\n".format(iType, iTypeValuesCount), headerLine, splitLine])
1339                    infoShort.extend(["\n### {}: [{}]\n\n".format(iType, iTypeValuesCount), headerLine, splitLine])
1340
1341                    for instrument in searchResults[iType].values():
1342                        info.append("| {:<10} | {:<12} | {:<63}| {:<13}|\n".format(
1343                            instrument["type"],
1344                            instrument["ticker"],
1345                            "{}...".format(instrument["name"][:60]) if len(instrument["name"]) > 63 else instrument["name"],  # right trim for a long string
1346                            instrument["figi"],
1347                        ))
1348
1349                    if iTypeValuesCount <= 5:
1350                        infoShort.extend(info[-iTypeValuesCount:])
1351
1352                    else:
1353                        infoShort.extend(info[-5:])
1354                        infoShort.append(skippedLine)
1355
1356        infoText = "".join(info)
1357        infoTextShort = "".join(infoShort)
1358
1359        if show:
1360            uLogger.info(infoTextShort)
1361            uLogger.info("You can view info about found instruments with key `--info`, e.g.: `tksbrokerapi -t IBM --info` or `tksbrokerapi -f BBG000BLNNH6 --info`")
1362
1363        if self.searchResultsFile:
1364            with open(self.searchResultsFile, "w", encoding="UTF-8") as fH:
1365                fH.write(infoText)
1366
1367            uLogger.info("Full search results were saved to file: [{}]".format(os.path.abspath(self.searchResultsFile)))
1368
1369        return searchResults
1370
1371    def GetUniqueFIGIs(self, instruments: list[str]) -> list:
1372        """
1373        Creating list with unique instrument FIGIs from input list of tickers or FIGIs.
1374
1375        :param instruments: list of strings with tickers or FIGIs.
1376        :return: list with unique instrument FIGIs only.
1377        """
1378        requestedInstruments = []
1379        for iName in instruments:
1380            if iName not in self.aliases.keys():
1381                if iName not in requestedInstruments:
1382                    requestedInstruments.append(iName)
1383
1384            else:
1385                if iName not in requestedInstruments:
1386                    if self.aliases[iName] not in requestedInstruments:
1387                        requestedInstruments.append(self.aliases[iName])
1388
1389        uLogger.debug("Requested instruments without duplicates of tickers or FIGIs: {}".format(requestedInstruments))
1390
1391        onlyUniqueFIGIs = []
1392        for iName in requestedInstruments:
1393            if iName in TKS_TICKERS_OR_FIGI_EXCLUDED:
1394                continue
1395
1396            self.ticker = iName
1397            iData = self.SearchByTicker(requestPrice=False)  # trying to find instrument by ticker
1398
1399            if not iData:
1400                self.ticker = ""
1401                self.figi = iName
1402
1403                iData = self.SearchByFIGI(requestPrice=False)  # trying to find instrument by FIGI
1404
1405                if not iData:
1406                    self.figi = ""
1407                    uLogger.warning("Instrument [{}] not in list of available instruments for current token!".format(iName))
1408
1409            if iData and iData["figi"] not in onlyUniqueFIGIs:
1410                onlyUniqueFIGIs.append(iData["figi"])
1411
1412        uLogger.debug("Unique list of FIGIs: {}".format(onlyUniqueFIGIs))
1413
1414        return onlyUniqueFIGIs
1415
1416    def GetListOfPrices(self, instruments: list, show: bool = False) -> list:
1417        """
1418        This method get, maybe show and return prices of list of instruments. WARNING! This is potential long operation!
1419        See limits: https://tinkoff.github.io/investAPI/limits/
1420        If `pricesFile` string is not empty then also save information to this file.
1421
1422        :param instruments: list of strings with tickers or FIGIs.
1423        :param show: if `True` then prints prices to console, if `False` - prints only to file `pricesFile`.
1424        :return: list of instruments looks like `[{some ticker info, "currentPrice": {current prices}}, {...}, ...]`.
1425                 One item is dict returned by `SearchByTicker()` or `SearchByFIGI()` methods.
1426        """
1427        if instruments is None or not instruments:
1428            uLogger.error("You must define some of tickers or FIGIs to request it's actual prices!")
1429            raise Exception("Ticker or FIGI required")
1430
1431        onlyUniqueFIGIs = self.GetUniqueFIGIs(instruments)
1432
1433        uLogger.debug("Requesting current prices from Tinkoff Broker server...")
1434
1435        iList = []  # trying to get info and current prices about all unique instruments:
1436        for self.figi in onlyUniqueFIGIs:
1437            iData = self.SearchByFIGI(requestPrice=True)
1438            iList.append(iData)
1439
1440        self.ShowListOfPrices(iList, show)
1441
1442        return iList
1443
1444    def ShowListOfPrices(self, iList: list, show: bool = True) -> str:
1445        """
1446        Show table contains current prices of given instruments.
1447
1448        :param iList: list of instruments looks like `[{some ticker info, "currentPrice": {current prices}}, {...}, ...]`.
1449                      One item is dict returned by `SearchByTicker(requestPrice=True)` or by `SearchByFIGI(requestPrice=True)` methods.
1450        :param show: if `True` then prints prices to console, if `False` - prints only to file `pricesFile`.
1451        :return: multilines text in Markdown format as a table contains current prices.
1452        """
1453        infoText = ""
1454
1455        if show or self.pricesFile:
1456            info = [
1457                "# Actual prices at: [{} UTC]\n\n".format(datetime.now(tzutc()).strftime("%Y-%m-%d %H:%M")),
1458                "| Ticker       | FIGI         | Type       | Prev. close | Last price  | Chg. %   | Day limits min/max  | Actual sell / buy   | Curr. |\n",
1459                "|--------------|--------------|------------|-------------|-------------|----------|---------------------|---------------------|-------|\n",
1460            ]
1461
1462            for item in iList:
1463                info.append("| {:<12} | {:<12} | {:<10} | {:>11} | {:>11} | {:>7}% | {:>19} | {:>19} | {:<5} |\n".format(
1464                    item["ticker"],
1465                    item["figi"],
1466                    item["type"],
1467                    "{:.2f}".format(float(item["currentPrice"]["closePrice"])),
1468                    "{:.2f}".format(float(item["currentPrice"]["lastPrice"])),
1469                    "{}{:.2f}".format("+" if item["currentPrice"]["changes"] > 0 else "", float(item["currentPrice"]["changes"])),
1470                    "{} / {}".format(
1471                        item["currentPrice"]["limitDown"] if item["currentPrice"]["limitDown"] is not None else "N/A",
1472                        item["currentPrice"]["limitUp"] if item["currentPrice"]["limitUp"] is not None else "N/A",
1473                    ),
1474                    "{} / {}".format(
1475                        item["currentPrice"]["sell"][0]["price"] if item["currentPrice"]["sell"] else "N/A",
1476                        item["currentPrice"]["buy"][0]["price"] if item["currentPrice"]["buy"] else "N/A",
1477                    ),
1478                    item["currency"],
1479                ))
1480
1481            infoText = "".join(info)
1482
1483            if show:
1484                uLogger.info("Only instruments with unique FIGIs are shown:\n{}".format(infoText))
1485
1486            if self.pricesFile:
1487                with open(self.pricesFile, "w", encoding="UTF-8") as fH:
1488                    fH.write(infoText)
1489
1490                uLogger.info("Price list for all instruments saved to file: [{}]".format(os.path.abspath(self.pricesFile)))
1491
1492        return infoText
1493
1494    def RequestTradingStatus(self) -> dict:
1495        """
1496        Requesting trading status for the instrument defined by `figi` variable.
1497        REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetTradingStatus
1498        Documentation: https://tinkoff.github.io/investAPI/marketdata/#gettradingstatusrequest
1499
1500        :return: dictionary with trading status attributes. Response example:
1501                 `{"figi": "TCS00A103X66", "tradingStatus": "SECURITY_TRADING_STATUS_NOT_AVAILABLE_FOR_TRADING",
1502                  "limitOrderAvailableFlag": false, "marketOrderAvailableFlag": false, "apiTradeAvailableFlag": true}`
1503        """
1504        if self.figi is None or not self.figi:
1505            uLogger.error("Variable `figi` must be defined for using this method!")
1506            raise Exception("FIGI required")
1507
1508        uLogger.debug("Requesting current trading status, FIGI: [{}]. Wait, please...".format(self.figi))
1509
1510        self.body = str({"figi": self.figi, "instrumentId": self.figi})
1511        tradingStatusURL = self.server + r"/tinkoff.public.invest.api.contract.v1.MarketDataService/GetTradingStatus"
1512        tradingStatus = self.SendAPIRequest(tradingStatusURL, reqType="POST")
1513
1514        uLogger.debug("Records about current trading status successfully received")
1515
1516        return tradingStatus
1517
1518    def RequestPortfolio(self) -> dict:
1519        """
1520        Requesting actual user's portfolio for current `accountId`.
1521        REST API for user portfolio: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetPortfolio
1522        Documentation: https://tinkoff.github.io/investAPI/operations/#portfoliorequest
1523
1524        :return: dictionary with user's portfolio.
1525        """
1526        if self.accountId is None or not self.accountId:
1527            uLogger.error("Variable `accountId` must be defined for using this method!")
1528            raise Exception("Account ID required")
1529
1530        uLogger.debug("Requesting current actual user's portfolio. Wait, please...")
1531
1532        self.body = str({"accountId": self.accountId})
1533        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetPortfolio"
1534        rawPortfolio = self.SendAPIRequest(portfolioURL, reqType="POST")
1535
1536        uLogger.debug("Records about user's portfolio successfully received")
1537
1538        return rawPortfolio
1539
1540    def RequestPositions(self) -> dict:
1541        """
1542        Requesting open positions by currencies and instruments for current `accountId`.
1543        REST API for open positions: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetPositions
1544        Documentation: https://tinkoff.github.io/investAPI/operations/#positionsrequest
1545
1546        :return: dictionary with open positions by instruments.
1547        """
1548        if self.accountId is None or not self.accountId:
1549            uLogger.error("Variable `accountId` must be defined for using this method!")
1550            raise Exception("Account ID required")
1551
1552        uLogger.debug("Requesting current open positions in currencies and instruments. Wait, please...")
1553
1554        self.body = str({"accountId": self.accountId})
1555        positionsURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetPositions"
1556        rawPositions = self.SendAPIRequest(positionsURL, reqType="POST")
1557
1558        uLogger.debug("Records about current open positions successfully received")
1559
1560        return rawPositions
1561
1562    def RequestPendingOrders(self) -> list:
1563        """
1564        Requesting current actual pending orders for current `accountId`.
1565        REST API for pending (market) orders: https://tinkoff.github.io/investAPI/swagger-ui/#/OrdersService/OrdersService_GetOrders
1566        Documentation: https://tinkoff.github.io/investAPI/orders/#getordersrequest
1567
1568        :return: list of dictionaries with pending orders.
1569        """
1570        if self.accountId is None or not self.accountId:
1571            uLogger.error("Variable `accountId` must be defined for using this method!")
1572            raise Exception("Account ID required")
1573
1574        uLogger.debug("Requesting current actual pending orders. Wait, please...")
1575
1576        self.body = str({"accountId": self.accountId})
1577        ordersURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/GetOrders"
1578        rawOrders = self.SendAPIRequest(ordersURL, reqType="POST")["orders"]
1579
1580        uLogger.debug("[{}] records about pending orders received".format(len(rawOrders)))
1581
1582        return rawOrders
1583
1584    def RequestStopOrders(self) -> list:
1585        """
1586        Requesting current actual stop orders for current `accountId`.
1587        REST API for opened stop-orders: https://tinkoff.github.io/investAPI/swagger-ui/#/StopOrdersService/StopOrdersService_GetStopOrders
1588        Documentation: https://tinkoff.github.io/investAPI/stoporders/#getstopordersrequest
1589
1590        :return: list of dictionaries with stop orders.
1591        """
1592        if self.accountId is None or not self.accountId:
1593            uLogger.error("Variable `accountId` must be defined for using this method!")
1594            raise Exception("Account ID required")
1595
1596        uLogger.debug("Requesting current actual stop orders. Wait, please...")
1597
1598        self.body = str({"accountId": self.accountId})
1599        ordersURL = self.server + r"/tinkoff.public.invest.api.contract.v1.StopOrdersService/GetStopOrders"
1600        rawStopOrders = self.SendAPIRequest(ordersURL, reqType="POST")["stopOrders"]
1601
1602        uLogger.debug("[{}] records about stop orders received".format(len(rawStopOrders)))
1603
1604        return rawStopOrders
1605
1606    def Overview(self, show: bool = False, details: str = "full") -> dict:
1607        """
1608        Get portfolio: all open positions, orders and some statistics for current `accountId`.
1609        If `overviewFile`, `overviewDigestFile`, `overviewPositionsFile`, `overviewOrdersFile`, `overviewAnalyticsFile`
1610        are defined then also save information to file.
1611
1612        WARNING! It is not recommended to run this method too many times in a loop! The server receives
1613        many requests about the state of the portfolio, and then, based on the received data, a large number
1614        of calculation and statistics are collected.
1615
1616        :param show: if `False` then only dictionary returns, if `True` then show more debug information.
1617        :param details: how detailed should the information be? You should specify one of strings:
1618                        `full` - shows full available information about portfolio status (by default),
1619                        `positions` - shows only open positions,
1620                        `digest` - show a short digest of the portfolio status,
1621                        `analytics` - shows only the analytics section and the distribution of the portfolio by various categories,
1622                        `orders` - shows only sections of open limits and stop orders.
1623        :return: dictionary with client's raw portfolio and some statistics.
1624        """
1625        if self.accountId is None or not self.accountId:
1626            uLogger.error("Variable `accountId` must be defined for using this method!")
1627            raise Exception("Account ID required")
1628
1629        view = {
1630            "raw": {  # --- raw portfolio responses from broker with user portfolio data:
1631                "headers": {},  # list of dictionaries, response headers without "positions" section
1632                "Currencies": [],  # list of dictionaries, open trades with currencies from "positions" section
1633                "Shares": [],  # list of dictionaries, open trades with shares from "positions" section
1634                "Bonds": [],  # list of dictionaries, open trades with bonds from "positions" section
1635                "Etfs": [],  # list of dictionaries, open trades with etfs from "positions" section
1636                "Futures": [],  # list of dictionaries, open trades with futures from "positions" section
1637                "positions": {},  # raw response from broker: dictionary with current available or blocked currencies and instruments for client
1638                "orders": [],  # raw response from broker: list of dictionaries with all pending (market) orders
1639                "stopOrders": [],  # raw response from broker: list of dictionaries with all stop orders
1640                "currenciesCurrentPrices": {"rub": {"name": "Российский рубль", "currentPrice": 1.}},  # dict with prices of all currencies in RUB
1641            },
1642            "stat": {  # --- some statistics calculated using "raw" sections:
1643                "portfolioCostRUB": 0.,  # portfolio cost in RUB (Russian Rouble)
1644                "availableRUB": 0.,  # available rubles (without other currencies)
1645                "blockedRUB": 0.,  # blocked sum in Russian Rouble
1646                "totalChangesRUB": 0.,  # changes for all open trades in RUB
1647                "totalChangesPercentRUB": 0.,  # changes for all open trades in percents
1648                "allCurrenciesCostRUB": 0.,  # costs of all currencies (include rubles) in RUB
1649                "sharesCostRUB": 0.,  # costs of all shares in RUB
1650                "bondsCostRUB": 0.,  # costs of all bonds in RUB
1651                "etfsCostRUB": 0.,  # costs of all etfs in RUB
1652                "futuresCostRUB": 0.,  # costs of all futures in RUB
1653                "Currencies": [],  # list of dictionaries of all currencies statistics
1654                "Shares": [],  # list of dictionaries of all shares statistics
1655                "Bonds": [],  # list of dictionaries of all bonds statistics
1656                "Etfs": [],  # list of dictionaries of all etfs statistics
1657                "Futures": [],  # list of dictionaries of all futures statistics
1658                "orders": [],  # list of dictionaries of all pending (market) orders and it's parameters
1659                "stopOrders": [],  # list of dictionaries of all stop orders and it's parameters
1660                "blockedCurrencies": {},  # dict with blocked instruments and currencies, e.g. {"rub": 1291.87, "usd": 6.21}
1661                "blockedInstruments": {},  # dict with blocked  by FIGI, e.g. {}
1662                "funds": {},  # dict with free funds for trading (total - blocked), by all currencies, e.g. {"rub": {"total": 10000.99, "totalCostRUB": 10000.99, "free": 1234.56, "freeCostRUB": 1234.56}, "usd": {"total": 250.55, "totalCostRUB": 15375.80, "free": 125.05, "freeCostRUB": 7687.50}}
1663            },
1664            "analytics": {  # --- some analytics of portfolio:
1665                "distrByAssets": {},  # portfolio distribution by assets
1666                "distrByCompanies": {},  # portfolio distribution by companies
1667                "distrBySectors": {},  # portfolio distribution by sectors
1668                "distrByCurrencies": {},  # portfolio distribution by currencies
1669                "distrByCountries": {},  # portfolio distribution by countries
1670            }
1671        }
1672
1673        details = details.lower()
1674        availableDetails = ["full", "positions", "digest", "analytics", "orders"]
1675        if details not in availableDetails:
1676            details = "full"
1677            uLogger.debug("Requested incorrect details! The `details` must be one of this strings: {}. Details parameter set to `full` be default.".format(availableDetails))
1678
1679        uLogger.debug("Requesting portfolio of a client. Wait, please...")
1680
1681        portfolioResponse = self.RequestPortfolio()  # current user's portfolio (dict)
1682        view["raw"]["positions"] = self.RequestPositions()  # current open positions by instruments (dict)
1683        view["raw"]["orders"] = self.RequestPendingOrders()  # current actual pending orders (list)
1684        view["raw"]["stopOrders"] = self.RequestStopOrders()  # current actual stop orders (list)
1685
1686        # save response headers without "positions" section:
1687        for key in portfolioResponse.keys():
1688            if key != "positions":
1689                view["raw"]["headers"][key] = portfolioResponse[key]
1690
1691            else:
1692                continue
1693
1694        # Re-sorting and separating given raw instruments and currencies by type: https://tinkoff.github.io/investAPI/operations/#operation
1695        # Type of instrument must be only one of supported types in TKS_INSTRUMENTS
1696        for item in portfolioResponse["positions"]:
1697            if item["instrumentType"] == "currency":
1698                self.figi = item["figi"]
1699                curr = self.SearchByFIGI(requestPrice=False)
1700
1701                # current price of currency in RUB:
1702                view["raw"]["currenciesCurrentPrices"][curr["nominal"]["currency"]] = {
1703                    "name": curr["name"],
1704                    "currentPrice": NanoToFloat(
1705                        item["currentPrice"]["units"],
1706                        item["currentPrice"]["nano"]
1707                    ),
1708                }
1709
1710                view["raw"]["Currencies"].append(item)
1711
1712            elif item["instrumentType"] == "share":
1713                view["raw"]["Shares"].append(item)
1714
1715            elif item["instrumentType"] == "bond":
1716                view["raw"]["Bonds"].append(item)
1717
1718            elif item["instrumentType"] == "etf":
1719                view["raw"]["Etfs"].append(item)
1720
1721            elif item["instrumentType"] == "futures":
1722                view["raw"]["Futures"].append(item)
1723
1724            else:
1725                continue
1726
1727        # how many volume of currencies (by ISO currency name) are blocked:
1728        for item in view["raw"]["positions"]["blocked"]:
1729            blocked = NanoToFloat(item["units"], item["nano"])
1730            if blocked > 0:
1731                view["stat"]["blockedCurrencies"][item["currency"]] = blocked
1732
1733        # how many volume of instruments (by FIGI) are blocked:
1734        for item in view["raw"]["positions"]["securities"]:
1735            blocked = int(item["blocked"])
1736            if blocked > 0:
1737                view["stat"]["blockedInstruments"][item["figi"]] = blocked
1738
1739        allBlocked = {**view["stat"]["blockedCurrencies"], **view["stat"]["blockedInstruments"]}
1740
1741        if "rub" in allBlocked.keys():
1742            view["stat"]["blockedRUB"] = allBlocked["rub"]  # blocked rubles
1743
1744        # --- saving current total amount in RUB of all currencies (with ruble), shares, bonds, etfs, futures and currencies:
1745        view["stat"]["allCurrenciesCostRUB"] = NanoToFloat(portfolioResponse["totalAmountCurrencies"]["units"], portfolioResponse["totalAmountCurrencies"]["nano"])
1746        view["stat"]["sharesCostRUB"] = NanoToFloat(portfolioResponse["totalAmountShares"]["units"], portfolioResponse["totalAmountShares"]["nano"])
1747        view["stat"]["bondsCostRUB"] = NanoToFloat(portfolioResponse["totalAmountBonds"]["units"], portfolioResponse["totalAmountBonds"]["nano"])
1748        view["stat"]["etfsCostRUB"] = NanoToFloat(portfolioResponse["totalAmountEtf"]["units"], portfolioResponse["totalAmountEtf"]["nano"])
1749        view["stat"]["futuresCostRUB"] = NanoToFloat(portfolioResponse["totalAmountFutures"]["units"], portfolioResponse["totalAmountFutures"]["nano"])
1750        view["stat"]["portfolioCostRUB"] = sum([
1751            view["stat"]["allCurrenciesCostRUB"],
1752            view["stat"]["sharesCostRUB"],
1753            view["stat"]["bondsCostRUB"],
1754            view["stat"]["etfsCostRUB"],
1755            view["stat"]["futuresCostRUB"],
1756        ])
1757
1758        # --- calculating some portfolio statistics:
1759        byComp = {}  # distribution by companies
1760        bySect = {}  # distribution by sectors
1761        byCurr = {}  # distribution by currencies (include RUB)
1762        unknownCountryName = "All other countries"  # default name for instruments without "countryOfRisk" and "countryOfRiskName"
1763        byCountry = {unknownCountryName: {"cost": 0, "percent": 0.}}  # distribution by countries (currencies are included in their countries)
1764
1765        for item in portfolioResponse["positions"]:
1766            self.figi = item["figi"]
1767            instrument = self.SearchByFIGI(requestPrice=False)  # full raw info about instrument by FIGI
1768
1769            if instrument:
1770                if item["instrumentType"] == "currency" and instrument["nominal"]["currency"] in allBlocked.keys():
1771                    blocked = allBlocked[instrument["nominal"]["currency"]]  # blocked volume of currency
1772
1773                elif item["instrumentType"] != "currency" and item["figi"] in allBlocked.keys():
1774                    blocked = allBlocked[item["figi"]]  # blocked volume of other instruments
1775
1776                else:
1777                    blocked = 0
1778
1779                volume = NanoToFloat(item["quantity"]["units"], item["quantity"]["nano"])  # available volume of instrument
1780                lots = NanoToFloat(item["quantityLots"]["units"], item["quantityLots"]["nano"])  # available volume in lots of instrument
1781                direction = "Long" if lots >= 0 else "Short"  # direction of an instrument's position: short or long
1782                curPrice = NanoToFloat(item["currentPrice"]["units"], item["currentPrice"]["nano"])  # current instrument's price
1783                average = NanoToFloat(item["averagePositionPriceFifo"]["units"], item["averagePositionPriceFifo"]["nano"])  # current average position price
1784                profit = NanoToFloat(item["expectedYield"]["units"], item["expectedYield"]["nano"])  # expected profit at current moment
1785                currency = instrument["currency"] if (item["instrumentType"] == "share" or item["instrumentType"] == "etf" or item["instrumentType"] == "future") else instrument["nominal"]["currency"]  # currency name rub, usd, eur etc.
1786                cost = (curPrice + NanoToFloat(item["currentNkd"]["units"], item["currentNkd"]["nano"])) * volume  # current cost of all volume of instrument in basic asset
1787                baseCurrencyName = item["currentPrice"]["currency"]  # name of base currency (rub)
1788                countryName = "[{}] {}".format(instrument["countryOfRisk"], instrument["countryOfRiskName"]) if "countryOfRisk" in instrument.keys() and "countryOfRiskName" in instrument.keys() and instrument["countryOfRisk"] and instrument["countryOfRiskName"] else unknownCountryName
1789                costRUB = cost if item["instrumentType"] == "currency" else cost * view["raw"]["currenciesCurrentPrices"][currency]["currentPrice"]  # cost in rubles
1790                percentCostRUB = 100 * costRUB / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.  # instrument's part in percent of full portfolio cost
1791
1792                statData = {
1793                    "figi": item["figi"],  # FIGI from REST API "GetPortfolio" method
1794                    "ticker": instrument["ticker"],  # ticker by FIGI
1795                    "currency": currency,  # currency name rub, usd, eur etc. for instrument price
1796                    "volume": volume,  # available volume of instrument
1797                    "lots": lots,  # volume in lots of instrument
1798                    "direction": direction,  # direction of an instrument's position: short or long
1799                    "blocked": blocked,  # blocked volume of currency or instrument
1800                    "currentPrice": curPrice,  # current instrument's price in basic asset
1801                    "average": average,  # current average position price
1802                    "cost": cost,  # current cost of all volume of instrument in basic asset
1803                    "baseCurrencyName": baseCurrencyName,  # name of base currency (rub)
1804                    "costRUB": costRUB,  # cost of instrument in ruble
1805                    "percentCostRUB": percentCostRUB,  # instrument's part in percent of full portfolio cost in RUB
1806                    "profit": profit,  # expected profit at current moment
1807                    "percentProfit": 100 * profit / (average * volume) if average != 0 and volume != 0 else 0,  # expected percents of profit at current moment for this instrument
1808                    "sector": instrument["sector"] if "sector" in instrument.keys() and instrument["sector"] else "other",
1809                    "name": instrument["name"] if "name" in instrument.keys() else "",  # human-readable names of instruments
1810                    "isoCurrencyName": instrument["isoCurrencyName"] if "isoCurrencyName" in instrument.keys() else "",  # ISO name for currencies only
1811                    "country": countryName,  # e.g. "[RU] Российская Федерация" or unknownCountryName
1812                    "step": instrument["step"],  # minimum price increment
1813                }
1814
1815                # adding distribution by unique countries:
1816                if statData["country"] not in byCountry.keys():
1817                    byCountry[statData["country"]] = {"cost": costRUB, "percent": percentCostRUB}
1818
1819                else:
1820                    byCountry[statData["country"]]["cost"] += costRUB
1821                    byCountry[statData["country"]]["percent"] += percentCostRUB
1822
1823                if item["instrumentType"] != "currency":
1824                    # adding distribution by unique companies:
1825                    if statData["name"]:
1826                        if statData["name"] not in byComp.keys():
1827                            byComp[statData["name"]] = {"ticker": statData["ticker"], "cost": costRUB, "percent": percentCostRUB}
1828
1829                        else:
1830                            byComp[statData["name"]]["cost"] += costRUB
1831                            byComp[statData["name"]]["percent"] += percentCostRUB
1832
1833                    # adding distribution by unique sectors:
1834                    if statData["sector"] not in bySect.keys():
1835                        bySect[statData["sector"]] = {"cost": costRUB, "percent": percentCostRUB}
1836
1837                    else:
1838                        bySect[statData["sector"]]["cost"] += costRUB
1839                        bySect[statData["sector"]]["percent"] += percentCostRUB
1840
1841                # adding distribution by unique currencies:
1842                if currency not in byCurr.keys():
1843                    byCurr[currency] = {
1844                        "name": view["raw"]["currenciesCurrentPrices"][currency]["name"],
1845                        "cost": costRUB,
1846                        "percent": percentCostRUB
1847                    }
1848
1849                else:
1850                    byCurr[currency]["cost"] += costRUB
1851                    byCurr[currency]["percent"] += percentCostRUB
1852
1853                # saving statistics for every instrument:
1854                if item["instrumentType"] == "currency":
1855                    view["stat"]["Currencies"].append(statData)
1856
1857                    # update dict with free funds for trading (total - blocked) by currencies
1858                    # e.g. {"rub": {"total": 10000.99, "totalCostRUB": 10000.99, "free": 1234.56, "freeCostRUB": 1234.56}, "usd": {"total": 250.55, "totalCostRUB": 15375.80, "free": 125.05, "freeCostRUB": 7687.50}}
1859                    view["stat"]["funds"][currency] = {
1860                        "total": volume,
1861                        "totalCostRUB": costRUB,  # total volume cost in rubles
1862                        "free": volume - blocked,
1863                        "freeCostRUB": costRUB * ((volume - blocked) / volume) if volume > 0 else 0,  # free volume cost in rubles
1864                    }
1865
1866                elif item["instrumentType"] == "share":
1867                    view["stat"]["Shares"].append(statData)
1868
1869                elif item["instrumentType"] == "bond":
1870                    view["stat"]["Bonds"].append(statData)
1871
1872                elif item["instrumentType"] == "etf":
1873                    view["stat"]["Etfs"].append(statData)
1874
1875                elif item["instrumentType"] == "Futures":
1876                    view["stat"]["Futures"].append(statData)
1877
1878                else:
1879                    continue
1880
1881        # total changes in Russian Ruble:
1882        view["stat"]["availableRUB"] = view["stat"]["allCurrenciesCostRUB"] - sum([item["cost"] for item in view["stat"]["Currencies"]])  # available RUB without other currencies
1883        view["stat"]["totalChangesPercentRUB"] = NanoToFloat(view["raw"]["headers"]["expectedYield"]["units"], view["raw"]["headers"]["expectedYield"]["nano"]) if "expectedYield" in view["raw"]["headers"].keys() else 0.
1884        startCost = view["stat"]["portfolioCostRUB"] / (1 + view["stat"]["totalChangesPercentRUB"] / 100)
1885        view["stat"]["totalChangesRUB"] = view["stat"]["portfolioCostRUB"] - startCost
1886        view["stat"]["funds"]["rub"] = {
1887            "total": view["stat"]["availableRUB"],
1888            "totalCostRUB": view["stat"]["availableRUB"],
1889            "free": view["stat"]["availableRUB"] - view["stat"]["blockedRUB"],
1890            "freeCostRUB": view["stat"]["availableRUB"] - view["stat"]["blockedRUB"],
1891        }
1892
1893        # --- pending orders sector data:
1894        uniquePendingOrders = []
1895        uniquePendingOrdersFIGIs = []
1896        for item in view["raw"]["orders"]:
1897            if item["figi"] not in uniquePendingOrdersFIGIs:
1898                uniquePendingOrdersFIGIs.append(item["figi"])
1899                uniquePendingOrders.append(item)
1900
1901        for item in uniquePendingOrders:
1902            self.figi = item["figi"]
1903            instrument = self.SearchByFIGI(requestPrice=True)  # full raw info about instrument by FIGI
1904
1905            if instrument:
1906                action = TKS_ORDER_DIRECTIONS[item["direction"]]
1907                orderType = TKS_ORDER_TYPES[item["orderType"]]
1908                orderState = TKS_ORDER_STATES[item["executionReportStatus"]]
1909                orderDate = item["orderDate"].replace("T", " ").replace("Z", "").split(".")[0]  # date in UTC format, e.g. "2022-12-31T23:59:59.123456Z"
1910
1911                # current instrument's price (last sellers order if buy, and last buyers order if sell):
1912                if item["direction"] == "ORDER_DIRECTION_BUY":
1913                    lastPrice = instrument["currentPrice"]["sell"][0]["price"] if instrument["currentPrice"]["sell"] else "N/A"
1914
1915                else:
1916                    lastPrice = instrument["currentPrice"]["buy"][0]["price"] if instrument["currentPrice"]["buy"] else "N/A"
1917
1918                # requested price for order execution:
1919                target = NanoToFloat(item["initialSecurityPrice"]["units"], item["initialSecurityPrice"]["nano"])
1920
1921                # necessary changes in percent to reach target from current price:
1922                changes = 100 * (lastPrice - target) / target if lastPrice != "N/A" and target > 0 else 0
1923
1924                view["stat"]["orders"].append({
1925                    "orderID": item["orderId"],  # orderId number parameter of current order
1926                    "figi": item["figi"],  # FIGI identification
1927                    "ticker": instrument["ticker"],  # ticker name by FIGI
1928                    "lotsRequested": item["lotsRequested"],  # requested lots value
1929                    "lotsExecuted": item["lotsExecuted"],  # how many lots are executed
1930                    "currentPrice": lastPrice,  # current instrument's price for defined action
1931                    "targetPrice": target,  # requested price for order execution in base currency
1932                    "baseCurrencyName": item["initialSecurityPrice"]["currency"],  # name of base currency
1933                    "percentChanges": changes,  # changes in percent to target from current price
1934                    "currency": item["currency"],  # instrument's currency name
1935                    "action": action,  # sell / buy / Unknown from TKS_ORDER_DIRECTIONS
1936                    "type": orderType,  # type of order from TKS_ORDER_TYPES
1937                    "status": orderState,  # order status from TKS_ORDER_STATES
1938                    "date": orderDate,  # string with order date and time from UTC format (without nano seconds part)
1939                })
1940
1941        # --- stop orders sector data:
1942        uniqueStopOrders = []
1943        uniqueStopOrdersFIGIs = []
1944        for item in view["raw"]["stopOrders"]:
1945            if item["figi"] not in uniqueStopOrdersFIGIs:
1946                uniqueStopOrdersFIGIs.append(item["figi"])
1947                uniqueStopOrders.append(item)
1948
1949        for item in uniqueStopOrders:
1950            self.figi = item["figi"]
1951            instrument = self.SearchByFIGI(requestPrice=True)  # full raw info about instrument by FIGI
1952
1953            if instrument:
1954                action = TKS_STOP_ORDER_DIRECTIONS[item["direction"]]
1955                orderType = TKS_STOP_ORDER_TYPES[item["orderType"]]
1956                createDate = item["createDate"].replace("T", " ").replace("Z", "").split(".")[0]  # date in UTC format, e.g. "2022-12-31T23:59:59.123456Z"
1957
1958                # hack: server response can't contain "expirationTime" key if it is not "Until date" type of stop order
1959                if "expirationTime" in item.keys():
1960                    expType = TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE"]
1961                    expDate = item["expirationTime"].replace("T", " ").replace("Z", "").split(".")[0]
1962
1963                else:
1964                    expType = TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL"]
1965                    expDate = TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED"]
1966
1967                # current instrument's price (last sellers order if buy, and last buyers order if sell):
1968                if item["direction"] == "STOP_ORDER_DIRECTION_BUY":
1969                    lastPrice = instrument["currentPrice"]["sell"][0]["price"] if instrument["currentPrice"]["sell"] else "N/A"
1970
1971                else:
1972                    lastPrice = instrument["currentPrice"]["buy"][0]["price"] if instrument["currentPrice"]["buy"] else "N/A"
1973
1974                # requested price when stop-order executed:
1975                target = NanoToFloat(item["stopPrice"]["units"], item["stopPrice"]["nano"])
1976
1977                # price for limit-order, set up when stop-order executed:
1978                limit = NanoToFloat(item["price"]["units"], item["price"]["nano"])
1979
1980                # necessary changes in percent to reach target from current price:
1981                changes = 100 * (lastPrice - target) / target if lastPrice != "N/A" and target > 0 else 0
1982
1983                view["stat"]["stopOrders"].append({
1984                    "orderID": item["stopOrderId"],  # stopOrderId number parameter of current stop-order
1985                    "figi": item["figi"],  # FIGI identification
1986                    "ticker": instrument["ticker"],  # ticker name by FIGI
1987                    "lotsRequested": item["lotsRequested"],  # requested lots value
1988                    "currentPrice": lastPrice,  # current instrument's price for defined action
1989                    "targetPrice": target,  # requested price for stop-order execution in base currency
1990                    "limitPrice": limit,  # price for limit-order, set up when stop-order executed, 0 if market order
1991                    "baseCurrencyName": item["stopPrice"]["currency"],  # name of base currency
1992                    "percentChanges": changes,  # changes in percent to target from current price
1993                    "currency": item["currency"],  # instrument's currency name
1994                    "action": action,  # sell / buy / Unknown from TKS_STOP_ORDER_DIRECTIONS
1995                    "type": orderType,  # type of order from TKS_STOP_ORDER_TYPES
1996                    "expType": expType,  # expiration type of stop-order from TKS_STOP_ORDER_EXPIRATION_TYPES
1997                    "createDate": createDate,  # string with created order date and time from UTC format (without nano seconds part)
1998                    "expDate": expDate,  # string with expiration order date and time from UTC format (without nano seconds part)
1999                })
2000
2001        # --- calculating data for analytics section:
2002        # portfolio distribution by assets:
2003        view["analytics"]["distrByAssets"] = {
2004            "Ruble": {
2005                "uniques": 1,
2006                "cost": view["stat"]["availableRUB"],
2007                "percent": 100 * view["stat"]["availableRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2008            },
2009            "Currencies": {
2010                "uniques": len(view["stat"]["Currencies"]),  # all foreign currencies without RUB
2011                "cost": view["stat"]["allCurrenciesCostRUB"] - view["stat"]["availableRUB"],
2012                "percent": 100 * (view["stat"]["allCurrenciesCostRUB"] - view["stat"]["availableRUB"]) / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2013            },
2014            "Shares": {
2015                "uniques": len(view["stat"]["Shares"]),
2016                "cost": view["stat"]["sharesCostRUB"],
2017                "percent": 100 * view["stat"]["sharesCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2018            },
2019            "Bonds": {
2020                "uniques": len(view["stat"]["Bonds"]),
2021                "cost": view["stat"]["bondsCostRUB"],
2022                "percent": 100 * view["stat"]["bondsCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2023            },
2024            "Etfs": {
2025                "uniques": len(view["stat"]["Etfs"]),
2026                "cost": view["stat"]["etfsCostRUB"],
2027                "percent": 100 * view["stat"]["etfsCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2028            },
2029            "Futures": {
2030                "uniques": len(view["stat"]["Futures"]),
2031                "cost": view["stat"]["futuresCostRUB"],
2032                "percent": 100 * view["stat"]["futuresCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2033            },
2034        }
2035
2036        # portfolio distribution by companies:
2037        view["analytics"]["distrByCompanies"]["All money cash"] = {
2038            "ticker": "",
2039            "cost": view["stat"]["allCurrenciesCostRUB"],
2040            "percent": 100 * view["stat"]["allCurrenciesCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2041        }
2042        view["analytics"]["distrByCompanies"].update(byComp)
2043
2044        # portfolio distribution by sectors:
2045        view["analytics"]["distrBySectors"]["All money cash"] = {
2046            "cost": view["analytics"]["distrByCompanies"]["All money cash"]["cost"],
2047            "percent": view["analytics"]["distrByCompanies"]["All money cash"]["percent"],
2048        }
2049        view["analytics"]["distrBySectors"].update(bySect)
2050
2051        # portfolio distribution by currencies:
2052        if "rub" not in view["analytics"]["distrByCurrencies"].keys():
2053            uLogger.debug("Fast hack to avoid issues #71 in `Portfolio distribution by currencies` section. Server not returned current available rubles!")
2054            view["analytics"]["distrByCurrencies"]["rub"] = {"name": "Российский рубль", "cost": 0, "percent": 0}
2055
2056        view["analytics"]["distrByCurrencies"].update(byCurr)
2057        view["analytics"]["distrByCurrencies"]["rub"]["cost"] += view["analytics"]["distrByAssets"]["Ruble"]["cost"]
2058        view["analytics"]["distrByCurrencies"]["rub"]["percent"] += view["analytics"]["distrByAssets"]["Ruble"]["percent"]
2059
2060        # portfolio distribution by countries:
2061        if "[RU] Российская Федерация" not in view["analytics"]["distrByCountries"].keys():
2062            uLogger.debug("Fast hack to avoid issues #71 in `Portfolio distribution by countries` section. Server not returned current available rubles!")
2063            view["analytics"]["distrByCountries"]["[RU] Российская Федерация"] = {"cost": 0, "percent": 0}
2064
2065        view["analytics"]["distrByCountries"].update(byCountry)
2066        view["analytics"]["distrByCountries"]["[RU] Российская Федерация"]["cost"] += view["analytics"]["distrByAssets"]["Ruble"]["cost"]
2067        view["analytics"]["distrByCountries"]["[RU] Российская Федерация"]["percent"] += view["analytics"]["distrByAssets"]["Ruble"]["percent"]
2068
2069        # --- Prepare text statistics overview in human-readable:
2070        if show:
2071            # Whatever the value `details`, header not changes:
2072            info = [
2073                "# Client's portfolio\n\n",
2074                "* **Actual date:** [{} UTC]\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
2075                "* **Account ID:** [{}]\n".format(self.accountId),
2076            ]
2077
2078            if details in ["full", "positions", "digest"]:
2079                info.extend([
2080                    "* **Portfolio cost:** {:.2f} RUB\n".format(view["stat"]["portfolioCostRUB"]),
2081                    "* **Changes:** {}{:.2f} RUB ({}{:.2f}%)\n\n".format(
2082                        "+" if view["stat"]["totalChangesRUB"] > 0 else "",
2083                        view["stat"]["totalChangesRUB"],
2084                        "+" if view["stat"]["totalChangesPercentRUB"] > 0 else "",
2085                        view["stat"]["totalChangesPercentRUB"],
2086                    ),
2087                ])
2088
2089            if details in ["full", "positions"]:
2090                info.extend([
2091                    "## Open positions\n\n",
2092                    "| Ticker [FIGI]               | Volume (blocked)                | Lots     | Curr. price  | Avg. price   | Current volume cost | Profit (%)                   |\n",
2093                    "|-----------------------------|---------------------------------|----------|--------------|--------------|---------------------|------------------------------|\n",
2094                    "| Ruble                       | {:>31} |          |              |              |                     |                              |\n".format(
2095                        "{:.2f} ({:.2f}) rub".format(
2096                            view["stat"]["availableRUB"],
2097                            view["stat"]["blockedRUB"],
2098                        )
2099                    )
2100                ])
2101
2102                def _SplitStr(CostRUB: float = 0, typeStr: str = "", noTradeStr: str = "") -> list:
2103                    return [
2104                        "|                             |                                 |          |              |              |                     |                              |\n",
2105                        "| {:<27} |                                 |          |              |              | {:>19} |                              |\n".format(
2106                            noTradeStr if noTradeStr else typeStr,
2107                            "" if noTradeStr else "{:.2f} RUB".format(CostRUB),
2108                        ),
2109                    ]
2110
2111                def _InfoStr(data: dict, showCurrencyName: bool = False) -> str:
2112                    return "| {:<27} | {:>31} | {:<8} | {:>12} | {:>12} | {:>19} | {:<28} |\n".format(
2113                        "{} [{}]".format(data["ticker"], data["figi"]),
2114                        "{:.2f} ({:.2f}) {}".format(
2115                            data["volume"],
2116                            data["blocked"],
2117                            data["currency"],
2118                        ) if showCurrencyName else "{:.0f} ({:.0f})".format(
2119                            data["volume"],
2120                            data["blocked"],
2121                        ),
2122                        "{:.4f}".format(data["lots"]) if showCurrencyName else "{:.0f}".format(data["lots"]),
2123                        "{:.2f} {}".format(data["currentPrice"], data["baseCurrencyName"]) if data["currentPrice"] > 0 else "n/a",
2124                        "{:.2f} {}".format(data["average"], data["baseCurrencyName"]) if data["average"] > 0 else "n/a",
2125                        "{:.2f} {}".format(data["cost"], data["baseCurrencyName"]),
2126                        "{}{:.2f} {} ({}{:.2f}%)".format(
2127                            "+" if data["profit"] > 0 else "",
2128                            data["profit"], data["baseCurrencyName"],
2129                            "+" if data["percentProfit"] > 0 else "",
2130                            data["percentProfit"],
2131                        ),
2132                    )
2133
2134                # --- Show currencies section:
2135                if view["stat"]["Currencies"]:
2136                    info.extend(_SplitStr(CostRUB=view["analytics"]["distrByAssets"]["Currencies"]["cost"], typeStr="**Currencies:**"))
2137                    for item in view["stat"]["Currencies"]:
2138                        info.append(_InfoStr(item, showCurrencyName=True))
2139
2140                else:
2141                    info.extend(_SplitStr(noTradeStr="**Currencies:** no trades"))
2142
2143                # --- Show shares section:
2144                if view["stat"]["Shares"]:
2145                    info.extend(_SplitStr(CostRUB=view["stat"]["sharesCostRUB"], typeStr="**Shares:**"))
2146
2147                    for item in view["stat"]["Shares"]:
2148                        info.append(_InfoStr(item))
2149
2150                else:
2151                    info.extend(_SplitStr(noTradeStr="**Shares:** no trades"))
2152
2153                # --- Show bonds section:
2154                if view["stat"]["Bonds"]:
2155                    info.extend(_SplitStr(CostRUB=view["stat"]["bondsCostRUB"], typeStr="**Bonds:**"))
2156
2157                    for item in view["stat"]["Bonds"]:
2158                        info.append(_InfoStr(item))
2159
2160                else:
2161                    info.extend(_SplitStr(noTradeStr="**Bonds:** no trades"))
2162
2163                # --- Show etfs section:
2164                if view["stat"]["Etfs"]:
2165                    info.extend(_SplitStr(CostRUB=view["stat"]["etfsCostRUB"], typeStr="**Etfs:**"))
2166
2167                    for item in view["stat"]["Etfs"]:
2168                        info.append(_InfoStr(item))
2169
2170                else:
2171                    info.extend(_SplitStr(noTradeStr="**Etfs:** no trades"))
2172
2173                # --- Show futures section:
2174                if view["stat"]["Futures"]:
2175                    info.extend(_SplitStr(CostRUB=view["stat"]["futuresCostRUB"], typeStr="**Futures:**"))
2176
2177                    for item in view["stat"]["Futures"]:
2178                        info.append(_InfoStr(item))
2179
2180                else:
2181                    info.extend(_SplitStr(noTradeStr="**Futures:** no trades"))
2182
2183            if details in ["full", "orders"]:
2184                # --- Show pending orders section:
2185                if view["stat"]["orders"]:
2186                    info.extend([
2187                        "\n## Opened pending limit-orders: {}\n".format(len(view["stat"]["orders"])),
2188                        "\n| Ticker [FIGI]               | Order ID       | Lots (exec.) | Current price (% delta) | Target price  | Action    | Type      | Create date (UTC)       |\n",
2189                        "|-----------------------------|----------------|--------------|-------------------------|---------------|-----------|-----------|-------------------------|\n",
2190                    ])
2191
2192                    for item in view["stat"]["orders"]:
2193                        info.append("| {:<27} | {:<14} | {:<12} | {:>23} | {:>13} | {:<9} | {:<9} | {:<23} |\n".format(
2194                            "{} [{}]".format(item["ticker"], item["figi"]),
2195                            item["orderID"],
2196                            "{} ({})".format(item["lotsRequested"], item["lotsExecuted"]),
2197                            "{} {} ({}{:.2f}%)".format(
2198                                "{}".format(item["currentPrice"]) if isinstance(item["currentPrice"], str) else "{:.2f}".format(float(item["currentPrice"])),
2199                                item["baseCurrencyName"],
2200                                "+" if item["percentChanges"] > 0 else "",
2201                                float(item["percentChanges"]),
2202                            ),
2203                            "{:.2f} {}".format(float(item["targetPrice"]), item["baseCurrencyName"]),
2204                            item["action"],
2205                            item["type"],
2206                            item["date"],
2207                        ))
2208
2209                else:
2210                    info.append("\n## Total pending limit-orders: 0\n")
2211
2212                # --- Show stop orders section:
2213                if view["stat"]["stopOrders"]:
2214                    info.extend([
2215                        "\n## Opened stop-orders: {}\n".format(len(view["stat"]["stopOrders"])),
2216                        "\n| Ticker [FIGI]               | Stop order ID                        | Lots   | Current price (% delta) | Target price  | Limit price   | Action    | Type        | Expire type  | Create date (UTC)   | Expiration (UTC)    |\n",
2217                        "|-----------------------------|--------------------------------------|--------|-------------------------|---------------|---------------|-----------|-------------|--------------|---------------------|---------------------|\n",
2218                    ])
2219
2220                    for item in view["stat"]["stopOrders"]:
2221                        info.append("| {:<27} | {:<14} | {:<6} | {:>23} | {:>13} | {:>13} | {:<9} | {:<11} | {:<12} | {:<19} | {:<19} |\n".format(
2222                            "{} [{}]".format(item["ticker"], item["figi"]),
2223                            item["orderID"],
2224                            item["lotsRequested"],
2225                            "{} {} ({}{:.2f}%)".format(
2226                                "{}".format(item["currentPrice"]) if isinstance(item["currentPrice"], str) else "{:.2f}".format(float(item["currentPrice"])),
2227                                item["baseCurrencyName"],
2228                                "+" if item["percentChanges"] > 0 else "",
2229                                float(item["percentChanges"]),
2230                            ),
2231                            "{:.2f} {}".format(float(item["targetPrice"]), item["baseCurrencyName"]),
2232                            "{:.2f} {}".format(float(item["limitPrice"]), item["baseCurrencyName"]) if item["limitPrice"] and item["limitPrice"] != item["targetPrice"] else TKS_ORDER_TYPES["ORDER_TYPE_MARKET"],
2233                            item["action"],
2234                            item["type"],
2235                            item["expType"],
2236                            item["createDate"],
2237                            item["expDate"],
2238                        ))
2239
2240                else:
2241                    info.append("\n## Total stop-orders: 0\n")
2242
2243            if details in ["full", "analytics"]:
2244                # -- Show analytics section:
2245                if view["stat"]["portfolioCostRUB"] > 0:
2246                    info.extend([
2247                        "\n# Analytics\n"
2248                        "\n* **Current total portfolio cost:** {:.2f} RUB\n".format(view["stat"]["portfolioCostRUB"]),
2249                        "* **Changes:** {}{:.2f} RUB ({}{:.2f}%)\n".format(
2250                            "+" if view["stat"]["totalChangesRUB"] > 0 else "",
2251                            view["stat"]["totalChangesRUB"],
2252                            "+" if view["stat"]["totalChangesPercentRUB"] > 0 else "",
2253                            view["stat"]["totalChangesPercentRUB"],
2254                        ),
2255                        "\n## Portfolio distribution by assets\n"
2256                        "\n| Type       | Uniques | Percent | Current cost       |\n",
2257                        "|------------|---------|---------|--------------------|\n",
2258                    ])
2259
2260                    for key in view["analytics"]["distrByAssets"].keys():
2261                        if view["analytics"]["distrByAssets"][key]["cost"] > 0:
2262                            info.append("| {:<10} | {:<7} | {:<7} | {:<18} |\n".format(
2263                                key,
2264                                view["analytics"]["distrByAssets"][key]["uniques"],
2265                                "{:.2f}%".format(view["analytics"]["distrByAssets"][key]["percent"]),
2266                                "{:.2f} rub".format(view["analytics"]["distrByAssets"][key]["cost"]),
2267                            ))
2268
2269                    maxLenNames = 3 + max([len(company) + len(view["analytics"]["distrByCompanies"][company]["ticker"]) for company in view["analytics"]["distrByCompanies"].keys()])
2270                    info.extend([
2271                        "\n## Portfolio distribution by companies\n"
2272                        "\n| Company{} | Percent | Current cost       |\n".format(" " * (maxLenNames - 7)),
2273                        "|--------{}-|---------|--------------------|\n".format("-" * (maxLenNames - 7)),
2274                    ])
2275
2276                    for company in view["analytics"]["distrByCompanies"].keys():
2277                        if view["analytics"]["distrByCompanies"][company]["cost"] > 0:
2278                            nameLen = len(company) + len(view["analytics"]["distrByCompanies"][company]["ticker"])
2279                            info.append("| {} | {:<7} | {:<18} |\n".format(
2280                                "{}{}{}".format(
2281                                    "[{}] ".format(view["analytics"]["distrByCompanies"][company]["ticker"]) if view["analytics"]["distrByCompanies"][company]["ticker"] else "",
2282                                    company,
2283                                    "" if nameLen == maxLenNames else "{}".format(" " * (maxLenNames - nameLen - 3) if view["analytics"]["distrByCompanies"][company]["ticker"] else " " * (maxLenNames - nameLen)),
2284                                ),
2285                                "{:.2f}%".format(view["analytics"]["distrByCompanies"][company]["percent"]),
2286                                "{:.2f} rub".format(view["analytics"]["distrByCompanies"][company]["cost"]),
2287                            ))
2288
2289                    maxLenSectors = max([len(sector) for sector in view["analytics"]["distrBySectors"].keys()])
2290                    info.extend([
2291                        "\n## Portfolio distribution by sectors\n"
2292                        "\n| Sector{} | Percent | Current cost       |\n".format(" " * (maxLenSectors - 6)),
2293                        "|-------{}-|---------|--------------------|\n".format("-" * (maxLenSectors - 6)),
2294                    ])
2295
2296                    for sector in view["analytics"]["distrBySectors"].keys():
2297                        if view["analytics"]["distrBySectors"][sector]["cost"] > 0:
2298                            info.append("| {}{} | {:<7} | {:<18} |\n".format(
2299                                sector,
2300                                "" if len(sector) == maxLenSectors else " " * (maxLenSectors - len(sector)),
2301                                "{:.2f}%".format(view["analytics"]["distrBySectors"][sector]["percent"]),
2302                                "{:.2f} rub".format(view["analytics"]["distrBySectors"][sector]["cost"]),
2303                            ))
2304
2305                    maxLenMoney = 3 + max([len(currency) + len(view["analytics"]["distrByCurrencies"][currency]["name"]) for currency in view["analytics"]["distrByCurrencies"].keys()])
2306                    info.extend([
2307                        "\n## Portfolio distribution by currencies\n"
2308                        "\n| Instruments currencies{} | Percent | Current cost       |\n".format(" " * (maxLenMoney - 22)),
2309                        "|-----------------------{}-|---------|--------------------|\n".format("-" * (maxLenMoney - 22)),
2310                    ])
2311
2312                    for curr in view["analytics"]["distrByCurrencies"].keys():
2313                        if view["analytics"]["distrByCurrencies"][curr]["cost"] > 0:
2314                            nameLen = 3 + len(curr) + len(view["analytics"]["distrByCurrencies"][curr]["name"])
2315                            info.append("| {} | {:<7} | {:<18} |\n".format(
2316                                "[{}] {}{}".format(
2317                                    curr,
2318                                    view["analytics"]["distrByCurrencies"][curr]["name"],
2319                                    "" if nameLen == maxLenMoney else " " * (maxLenMoney - nameLen),
2320                                ),
2321                                "{:.2f}%".format(view["analytics"]["distrByCurrencies"][curr]["percent"]),
2322                                "{:.2f} rub".format(view["analytics"]["distrByCurrencies"][curr]["cost"]),
2323                            ))
2324
2325                    maxLenCountry = max(17, max([len(country) for country in view["analytics"]["distrByCountries"].keys()]))
2326                    info.extend([
2327                        "\n## Portfolio distribution by countries\n"
2328                        "\n| Assets by country{} | Percent | Current cost       |\n".format(" " * (maxLenCountry - 17)),
2329                        "|------------------{}-|---------|--------------------|\n".format("-" * (maxLenCountry - 17)),
2330                    ])
2331
2332                    for country in view["analytics"]["distrByCountries"].keys():
2333                        if view["analytics"]["distrByCountries"][country]["cost"] > 0:
2334                            nameLen = len(country)
2335                            info.append("| {} | {:<7} | {:<18} |\n".format(
2336                                "{}{}".format(
2337                                    country,
2338                                    "" if nameLen == maxLenCountry else " " * (maxLenCountry - nameLen),
2339                                ),
2340                                "{:.2f}%".format(view["analytics"]["distrByCountries"][country]["percent"]),
2341                                "{:.2f} rub".format(view["analytics"]["distrByCountries"][country]["cost"]),
2342                            ))
2343
2344            infoText = "".join(info)
2345
2346            uLogger.info(infoText)
2347
2348            if details == "full" and self.overviewFile:
2349                filename = self.overviewFile
2350
2351            elif details == "digest" and self.overviewDigestFile:
2352                filename = self.overviewDigestFile
2353
2354            elif details == "positions" and self.overviewPositionsFile:
2355                filename = self.overviewPositionsFile
2356
2357            elif details == "orders" and self.overviewOrdersFile:
2358                filename = self.overviewOrdersFile
2359
2360            elif details == "analytics" and self.overviewAnalyticsFile:
2361                filename = self.overviewAnalyticsFile
2362
2363            else:
2364                filename = ""
2365
2366            if filename:
2367                with open(filename, "w", encoding="UTF-8") as fH:
2368                    fH.write(infoText)
2369
2370                uLogger.info("Client's portfolio was saved to file: [{}]".format(os.path.abspath(filename)))
2371
2372        return view
2373
2374    def Deals(self, start: str = None, end: str = None, show: bool = False, showCancelled: bool = True) -> tuple:
2375        """
2376        Returns history operations between two given dates for current `accountId`.
2377        If `reportFile` string is not empty then also save human-readable report.
2378        Shows some statistical data of closed positions.
2379
2380        :param start: see docstring in `GetDatesAsString()` method
2381        :param end: see docstring in `GetDatesAsString()` method
2382        :param show: if `True` then also prints all records to the console.
2383        :param showCancelled: if `False` then remove information about cancelled operations from the deals report.
2384        :return: original list of dictionaries with history of deals records from API ("operations" key):
2385                 https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetOperations
2386                 and dictionary with custom stats: operations in different currencies, withdrawals, incomes etc.
2387        """
2388        if self.accountId is None or not self.accountId:
2389            uLogger.error("Variable `accountId` must be defined for using this method!")
2390            raise Exception("Account ID required")
2391
2392        startDate, endDate = GetDatesAsString(start, end)  # Example: ("2000-01-01T00:00:00Z", "2022-12-31T23:59:59Z")
2393
2394        uLogger.debug("Requesting history of a client's operations. Wait, please...")
2395
2396        # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetOperations
2397        dealsURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetOperations"
2398        self.body = str({"accountId": self.accountId, "from": startDate, "to": endDate})
2399        ops = self.SendAPIRequest(dealsURL, reqType="POST")["operations"]  # list of dict: operations returns by broker
2400        customStat = {}  # custom statistics in additional to responseJSON
2401
2402        # --- output report in human-readable format:
2403        if show or self.reportFile:
2404            splitLine1 = "|                            |                               |                              |                      |                        |\n"  # Summary section
2405            splitLine2 = "|                     |              |              |            |           |                 |            |                                                                    |\n"  # Operations section
2406            nextDay = ""
2407
2408            info = ["# Client's operations\n\n* **Period:** from [{}] to [{}]\n\n## Summary (operations executed only)\n\n".format(startDate.split("T")[0], endDate.split("T")[0])]
2409
2410            if len(ops) > 0:
2411                customStat = {
2412                    "opsCount": 0,  # total operations count
2413                    "buyCount": 0,  # buy operations
2414                    "sellCount": 0,  # sell operations
2415                    "buyTotal": {"rub": 0.},  # Buy sums in different currencies
2416                    "sellTotal": {"rub": 0.},  # Sell sums in different currencies
2417                    "payIn": {"rub": 0.},  # Deposit brokerage account
2418                    "payOut": {"rub": 0.},  # Withdrawals
2419                    "divs": {"rub": 0.},  # Dividends income
2420                    "coupons": {"rub": 0.},  # Coupon's income
2421                    "brokerCom": {"rub": 0.},  # Service commissions
2422                    "serviceCom": {"rub": 0.},  # Service commissions
2423                    "marginCom": {"rub": 0.},  # Margin commissions
2424                    "allTaxes": {"rub": 0.},  # Sum of withholding taxes and corrections
2425                }
2426
2427                # --- calculating statistics depends on operations type in TKS_OPERATION_TYPES:
2428                for item in ops:
2429                    if item["state"] == "OPERATION_STATE_EXECUTED":
2430                        payment = NanoToFloat(item["payment"]["units"], item["payment"]["nano"])
2431
2432                        # count buy operations:
2433                        if "_BUY" in item["operationType"]:
2434                            customStat["buyCount"] += 1
2435
2436                            if item["payment"]["currency"] in customStat["buyTotal"].keys():
2437                                customStat["buyTotal"][item["payment"]["currency"]] += payment
2438
2439                            else:
2440                                customStat["buyTotal"][item["payment"]["currency"]] = payment
2441
2442                        # count sell operations:
2443                        elif "_SELL" in item["operationType"]:
2444                            customStat["sellCount"] += 1
2445
2446                            if item["payment"]["currency"] in customStat["sellTotal"].keys():
2447                                customStat["sellTotal"][item["payment"]["currency"]] += payment
2448
2449                            else:
2450                                customStat["sellTotal"][item["payment"]["currency"]] = payment
2451
2452                        # count incoming operations:
2453                        elif item["operationType"] in ["OPERATION_TYPE_INPUT"]:
2454                            if item["payment"]["currency"] in customStat["payIn"].keys():
2455                                customStat["payIn"][item["payment"]["currency"]] += payment
2456
2457                            else:
2458                                customStat["payIn"][item["payment"]["currency"]] = payment
2459
2460                        # count withdrawals operations:
2461                        elif item["operationType"] in ["OPERATION_TYPE_OUTPUT"]:
2462                            if item["payment"]["currency"] in customStat["payOut"].keys():
2463                                customStat["payOut"][item["payment"]["currency"]] += payment
2464
2465                            else:
2466                                customStat["payOut"][item["payment"]["currency"]] = payment
2467
2468                        # count dividends income:
2469                        elif item["operationType"] in ["OPERATION_TYPE_DIVIDEND", "OPERATION_TYPE_DIVIDEND_TRANSFER", "OPERATION_TYPE_DIV_EXT"]:
2470                            if item["payment"]["currency"] in customStat["divs"].keys():
2471                                customStat["divs"][item["payment"]["currency"]] += payment
2472
2473                            else:
2474                                customStat["divs"][item["payment"]["currency"]] = payment
2475
2476                        # count coupon's income:
2477                        elif item["operationType"] in ["OPERATION_TYPE_COUPON", "OPERATION_TYPE_BOND_REPAYMENT_FULL", "OPERATION_TYPE_BOND_REPAYMENT"]:
2478                            if item["payment"]["currency"] in customStat["coupons"].keys():
2479                                customStat["coupons"][item["payment"]["currency"]] += payment
2480
2481                            else:
2482                                customStat["coupons"][item["payment"]["currency"]] = payment
2483
2484                        # count broker commissions:
2485                        elif item["operationType"] in ["OPERATION_TYPE_BROKER_FEE", "OPERATION_TYPE_SUCCESS_FEE", "OPERATION_TYPE_TRACK_MFEE", "OPERATION_TYPE_TRACK_PFEE"]:
2486                            if item["payment"]["currency"] in customStat["brokerCom"].keys():
2487                                customStat["brokerCom"][item["payment"]["currency"]] += payment
2488
2489                            else:
2490                                customStat["brokerCom"][item["payment"]["currency"]] = payment
2491
2492                        # count service commissions:
2493                        elif item["operationType"] in ["OPERATION_TYPE_SERVICE_FEE"]:
2494                            if item["payment"]["currency"] in customStat["serviceCom"].keys():
2495                                customStat["serviceCom"][item["payment"]["currency"]] += payment
2496
2497                            else:
2498                                customStat["serviceCom"][item["payment"]["currency"]] = payment
2499
2500                        # count margin commissions:
2501                        elif item["operationType"] in ["OPERATION_TYPE_MARGIN_FEE"]:
2502                            if item["payment"]["currency"] in customStat["marginCom"].keys():
2503                                customStat["marginCom"][item["payment"]["currency"]] += payment
2504
2505                            else:
2506                                customStat["marginCom"][item["payment"]["currency"]] = payment
2507
2508                        # count withholding taxes:
2509                        elif "_TAX" in item["operationType"]:
2510                            if item["payment"]["currency"] in customStat["allTaxes"].keys():
2511                                customStat["allTaxes"][item["payment"]["currency"]] += payment
2512
2513                            else:
2514                                customStat["allTaxes"][item["payment"]["currency"]] = payment
2515
2516                        else:
2517                            continue
2518
2519                customStat["opsCount"] += customStat["buyCount"] + customStat["sellCount"]
2520
2521                # --- view "Actions" lines:
2522                info.extend([
2523                    "| 1                          | 2                             | 3                            | 4                    | 5                      |\n",
2524                    "|----------------------------|-------------------------------|------------------------------|----------------------|------------------------|\n",
2525                    "| **Actions:**               | Trades: {:<21} | Trading volumes:             |                      |                        |\n".format(customStat["opsCount"]),
2526                    "|                            |   Buy: {:<22} | {:<28} |                      |                        |\n".format(
2527                        "{} ({:.1f}%)".format(customStat["buyCount"], 100 * customStat["buyCount"] / customStat["opsCount"]) if customStat["opsCount"] != 0 else 0,
2528                        "  rub, buy: {:<16}".format("{:.2f}".format(customStat["buyTotal"]["rub"])) if customStat["buyTotal"]["rub"] != 0 else "  —",
2529                    ),
2530                    "|                            |   Sell: {:<21} | {:<28} |                      |                        |\n".format(
2531                        "{} ({:.1f}%)".format(customStat["sellCount"], 100 * customStat["sellCount"] / customStat["opsCount"]) if customStat["opsCount"] != 0 else 0,
2532                        "  rub, sell: {:<13}".format("+{:.2f}".format(customStat["sellTotal"]["rub"])) if customStat["sellTotal"]["rub"] != 0 else "  —",
2533                    ),
2534                ])
2535
2536                opsKeys = sorted(list(set(list(customStat["buyTotal"].keys()) + list(customStat["sellTotal"].keys()))))
2537                for key in opsKeys:
2538                    if key == "rub":
2539                        continue
2540
2541                    info.extend([
2542                        "|                            |                               | {:<28} |                      |                        |\n".format(
2543                            "  {}, buy: {:<16}".format(key, "{:.2f}".format(customStat["buyTotal"][key]) if key and key in customStat["buyTotal"].keys() and customStat["buyTotal"][key] != 0 else 0)
2544                        ),
2545                        "|                            |                               | {:<28} |                      |                        |\n".format(
2546                            "  {}, sell: {:<13}".format(key, "+{:.2f}".format(customStat["sellTotal"][key]) if key and key in customStat["sellTotal"].keys() and customStat["sellTotal"][key] != 0 else 0)
2547                        ),
2548                    ])
2549
2550                info.append(splitLine1)
2551
2552                def _InfoStr(data1: dict, data2: dict, data3: dict, data4: dict, cur: str = "") -> str:
2553                    return "|                            | {:<29} | {:<28} | {:<20} | {:<22} |\n".format(
2554                            "  {}: {}{:.2f}".format(cur, "+" if data1[cur] > 0 else "", data1[cur]) if cur and cur in data1.keys() and data1[cur] != 0 else "  —",
2555                            "  {}: {}{:.2f}".format(cur, "+" if data2[cur] > 0 else "", data2[cur]) if cur and cur in data2.keys() and data2[cur] != 0 else "  —",
2556                            "  {}: {}{:.2f}".format(cur, "+" if data3[cur] > 0 else "", data3[cur]) if cur and cur in data3.keys() and data3[cur] != 0 else "  —",
2557                            "  {}: {}{:.2f}".format(cur, "+" if data4[cur] > 0 else "", data4[cur]) if cur and cur in data4.keys() and data4[cur] != 0 else "  —",
2558                    )
2559
2560                # --- view "Payments" lines:
2561                info.append("| **Payments:**              | Deposit on broker account:    | Withdrawals:                 | Dividends income:    | Coupons income:        |\n")
2562                paymentsKeys = sorted(list(set(list(customStat["payIn"].keys()) + list(customStat["payOut"].keys()) + list(customStat["divs"].keys()) + list(customStat["coupons"].keys()))))
2563
2564                for key in paymentsKeys:
2565                    info.append(_InfoStr(customStat["payIn"], customStat["payOut"], customStat["divs"], customStat["coupons"], key))
2566
2567                info.append(splitLine1)
2568
2569                # --- view "Commissions and taxes" lines:
2570                info.append("| **Commissions and taxes:** | Broker commissions:           | Service commissions:         | Margin commissions:  | All taxes/corrections: |\n")
2571                comKeys = sorted(list(set(list(customStat["brokerCom"].keys()) + list(customStat["serviceCom"].keys()) + list(customStat["marginCom"].keys()) + list(customStat["allTaxes"].keys()))))
2572
2573                for key in comKeys:
2574                    info.append(_InfoStr(customStat["brokerCom"], customStat["serviceCom"], customStat["marginCom"], customStat["allTaxes"], key))
2575
2576                info.append(splitLine1)
2577
2578                info.extend([
2579                    "\n## All operations{}\n\n".format("" if showCancelled else " (without cancelled status)"),
2580                    "| Date and time       | FIGI         | Ticker       | Asset      | Value     | Payment         | Status     | Operation type                                                     |\n",
2581                    "|---------------------|--------------|--------------|------------|-----------|-----------------|------------|--------------------------------------------------------------------|\n",
2582                ])
2583
2584            else:
2585                info.append("Broker returned no operations during this period\n")
2586
2587            # --- view "Operations" section:
2588            for item in ops:
2589                if not showCancelled and TKS_OPERATION_STATES[item["state"]] == TKS_OPERATION_STATES["OPERATION_STATE_CANCELED"]:
2590                    continue
2591
2592                else:
2593                    self.figi = item["figi"] if item["figi"] else ""
2594                    payment = NanoToFloat(item["payment"]["units"], item["payment"]["nano"])
2595                    instrument = self.SearchByFIGI(requestPrice=False) if self.figi else {}
2596
2597                    # group of deals during one day:
2598                    if nextDay and item["date"].split("T")[0] != nextDay:
2599                        info.append(splitLine2)
2600                        nextDay = ""
2601
2602                    else:
2603                        nextDay = item["date"].split("T")[0]  # saving current day for splitting
2604
2605                    info.append("| {:<19} | {:<12} | {:<12} | {:<10} | {:<9} | {:>15} | {:<10} | {:<66} |\n".format(
2606                        item["date"].replace("T", " ").replace("Z", "").split(".")[0],
2607                        self.figi if self.figi else "—",
2608                        instrument["ticker"] if instrument else "—",
2609                        instrument["type"] if instrument else "—",
2610                        item["quantity"] if int(item["quantity"]) > 0 else "—",
2611                        "{}{:.2f} {}".format("+" if payment > 0 else "", payment, item["payment"]["currency"]) if payment != 0 else "—",
2612                        TKS_OPERATION_STATES[item["state"]],
2613                        TKS_OPERATION_TYPES[item["operationType"]],
2614                    ))
2615
2616            infoText = "".join(info)
2617
2618            if show:
2619                uLogger.info(infoText)
2620
2621            if self.reportFile:
2622                with open(self.reportFile, "w", encoding="UTF-8") as fH:
2623                    fH.write(infoText)
2624
2625                uLogger.info("History of a client's operations are saved to file: [{}]".format(os.path.abspath(self.reportFile)))
2626
2627        return ops, customStat
2628
2629    def History(self, start: str = None, end: str = None, interval: str = "hour", onlyMissing: bool = False, csvSep: str = ",", show: bool = False) -> pd.DataFrame:
2630        """
2631        This method returns last history candles of the current instrument defined by `ticker` or `figi` (FIGI id).
2632
2633        History returned between two given dates: `start` and `end`. Minimum requested date in the past is `1970-01-01`.
2634        Warning! Broker server used ISO UTC time by default.
2635
2636        If `historyFile` is not `None` then method save history to file, otherwise return only Pandas DataFrame.
2637        Also, `historyFile` used to update history with `onlyMissing` parameter.
2638
2639        See also: `LoadHistory()` and `ShowHistoryChart()` methods.
2640
2641        :param start: see docstring in `GetDatesAsString()` method.
2642        :param end: see docstring in `GetDatesAsString()` method.
2643        :param interval: this is a candle interval. Current available values are `"1min"`, `"5min"`, `"15min"`,
2644                         `"hour"`, `"day"`. Default: `"hour"`.
2645        :param onlyMissing: if `True` then add only last missing candles, do not request all history length from `start`.
2646                            False by default. Warning! History appends only from last candle to current time
2647                            with always update last candle!
2648        :param csvSep: separator if csv-file is used, `,` by default.
2649        :param show: if `True` then also prints Pandas DataFrame to the console.
2650        :return: Pandas DataFrame with prices history. Headers of columns are defined by default:
2651                 `["date", "time", "open", "high", "low", "close", "volume"]`.
2652        """
2653        strStartDate, strEndDate = GetDatesAsString(start, end)  # example: ("2020-01-01T00:00:00Z", "2022-12-31T23:59:59Z")
2654        headers = ["date", "time", "open", "high", "low", "close", "volume"]  # sequence and names of column headers
2655        history = None  # empty pandas object for history
2656
2657        if interval not in TKS_CANDLE_INTERVALS.keys():
2658            uLogger.error("Interval parameter must be string with current available values: `1min`, `5min`, `15min`, `hour` and `day`.")
2659            raise Exception("Incorrect value")
2660
2661        if not (self.ticker or self.figi):
2662            uLogger.error("Ticker or FIGI must be defined!")
2663            raise Exception("Ticker or FIGI required")
2664
2665        if self.ticker and not self.figi:
2666            instrumentByTicker = self.SearchByTicker(requestPrice=False, debug=False)
2667            self.figi = instrumentByTicker["figi"] if instrumentByTicker else ""
2668
2669        if self.figi and not self.ticker:
2670            instrumentByFIGI = self.SearchByFIGI(requestPrice=False, debug=False)
2671            self.ticker = instrumentByFIGI["ticker"] if instrumentByFIGI else ""
2672
2673        dtStart = datetime.strptime(strStartDate, TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc())  # datetime object from start time string
2674        dtEnd = datetime.strptime(strEndDate, TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc())  # datetime object from end time string
2675        if interval.lower() != "day":
2676            dtEnd += timedelta(seconds=1)  # adds 1 sec for requests, because day end returned by `GetDatesAsString()` as 23:59:59
2677
2678        delta = dtEnd - dtStart  # current UTC time minus last time in file
2679        deltaMinutes = delta.days * 1440 + delta.seconds // 60  # minutes between start and end dates
2680
2681        # calculate history length in candles:
2682        length = deltaMinutes // TKS_CANDLE_INTERVALS[interval][1]
2683        if deltaMinutes % TKS_CANDLE_INTERVALS[interval][1] > 0:
2684            length += 1  # to avoid fraction time
2685
2686        # calculate data blocks count:
2687        blocks = 1 if length < TKS_CANDLE_INTERVALS[interval][2] else 1 + length // TKS_CANDLE_INTERVALS[interval][2]
2688
2689        uLogger.debug("Original requested time period in local time: from [{}] to [{}]".format(start, end))
2690        uLogger.debug("Requested time period is about from [{}] UTC to [{}] UTC".format(strStartDate, strEndDate))
2691        uLogger.debug("Calculated history length: [{}], interval: [{}]".format(length, interval))
2692        uLogger.debug("Data blocks, count: [{}], max candles in block: [{}]".format(blocks, TKS_CANDLE_INTERVALS[interval][2]))
2693        uLogger.debug("Requesting history candlesticks, ticker: [{}], FIGI: [{}]. Wait, please...".format(self.ticker, self.figi))
2694
2695        tempOld = None  # pandas object for old history, if --only-missing key present
2696        lastTime = None  # datetime object of last old candle in file
2697
2698        if onlyMissing and self.historyFile is not None and self.historyFile and os.path.exists(self.historyFile):
2699            uLogger.debug("--only-missing key present, add only last missing candles...")
2700            uLogger.debug("History file will be updated: [{}]".format(os.path.abspath(self.historyFile)))
2701
2702            tempOld = pd.read_csv(self.historyFile, sep=csvSep, header=None, names=headers)
2703
2704            tempOld["date"] = pd.to_datetime(tempOld["date"])  # load date "as is"
2705            tempOld["date"] = tempOld["date"].dt.strftime("%Y.%m.%d")  # convert date to string
2706            tempOld["time"] = pd.to_datetime(tempOld["time"])  # load time "as is"
2707            tempOld["time"] = tempOld["time"].dt.strftime("%H:%M")  # convert time to string
2708
2709            # get last datetime object from last string in file or minus 1 delta if file is empty:
2710            if len(tempOld) > 0:
2711                lastTime = datetime.strptime(tempOld.date.iloc[-1] + " " + tempOld.time.iloc[-1], "%Y.%m.%d %H:%M").replace(tzinfo=tzutc())
2712
2713            else:
2714                lastTime = dtEnd - timedelta(days=1)  # history file is empty, so last date set at -1 day
2715
2716            tempOld = tempOld[:-1]  # always remove last old candle because it may be incompletely at the current time
2717
2718        responseJSONs = []  # raw history blocks of data
2719
2720        blockEnd = dtEnd
2721        for item in range(blocks):
2722            tail = length % TKS_CANDLE_INTERVALS[interval][2] if item + 1 == blocks else TKS_CANDLE_INTERVALS[interval][2]
2723            blockStart = blockEnd - timedelta(minutes=TKS_CANDLE_INTERVALS[interval][1] * tail)
2724
2725            uLogger.debug("[Block #{}/{}] time period: [{}] UTC - [{}] UTC".format(
2726                item + 1, blocks, blockStart.strftime(TKS_DATE_TIME_FORMAT), blockEnd.strftime(TKS_DATE_TIME_FORMAT),
2727            ))
2728
2729            if blockStart == blockEnd:
2730                uLogger.debug("Skipped this zero-length block...")
2731
2732            else:
2733                # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetCandles
2734                historyURL = self.server + r"/tinkoff.public.invest.api.contract.v1.MarketDataService/GetCandles"
2735                self.body = str({
2736                    "figi": self.figi,
2737                    "from": blockStart.strftime(TKS_DATE_TIME_FORMAT),
2738                    "to": blockEnd.strftime(TKS_DATE_TIME_FORMAT),
2739                    "interval": TKS_CANDLE_INTERVALS[interval][0]
2740                })
2741                responseJSON = self.SendAPIRequest(historyURL, reqType="POST", retry=1, pause=1, debug=False)
2742
2743                if "code" in responseJSON.keys():
2744                    uLogger.debug("An issue occurred and block #{}/{} is empty".format(item + 1, blocks))
2745
2746                else:
2747                    if start is not None and (start.lower() == "yesterday" or start == end) and interval == "day" and len(responseJSON["candles"]) > 1:
2748                        responseJSON["candles"] = responseJSON["candles"][:-1]  # removes last candle for "yesterday" request
2749
2750                    responseJSONs = responseJSON["candles"] + responseJSONs  # add more old history behind newest dates
2751
2752            blockEnd = blockStart
2753
2754        printCount = len(responseJSONs)  # candles to show in console
2755        if responseJSONs:
2756            tempHistory = pd.DataFrame(
2757                data={
2758                    "date": [pd.to_datetime(item["time"]).astimezone(tzutc()) for item in responseJSONs],
2759                    "time": [pd.to_datetime(item["time"]).astimezone(tzutc()) for item in responseJSONs],
2760                    "open": [NanoToFloat(item["open"]["units"], item["open"]["nano"]) for item in responseJSONs],
2761                    "high": [NanoToFloat(item["high"]["units"], item["high"]["nano"]) for item in responseJSONs],
2762                    "low": [NanoToFloat(item["low"]["units"], item["low"]["nano"]) for item in responseJSONs],
2763                    "close": [NanoToFloat(item["close"]["units"], item["close"]["nano"]) for item in responseJSONs],
2764                    "volume": [int(item["volume"]) for item in responseJSONs],
2765                },
2766                index=range(len(responseJSONs)),
2767                columns=["date", "time", "open", "high", "low", "close", "volume"],
2768            )
2769            tempHistory["date"] = tempHistory["date"].dt.strftime("%Y.%m.%d")
2770            tempHistory["time"] = tempHistory["time"].dt.strftime("%H:%M")
2771
2772            # append only newest candles to old history if --only-missing key present:
2773            if onlyMissing and tempOld is not None and lastTime is not None:
2774                index = 0  # find start index in tempHistory data:
2775
2776                for i, item in tempHistory.iterrows():
2777                    curTime = datetime.strptime(item["date"] + " " + item["time"], "%Y.%m.%d %H:%M").replace(tzinfo=tzutc())
2778
2779                    if curTime == lastTime:
2780                        uLogger.debug("History will be updated starting from the date: [{}]".format(curTime.strftime(TKS_PRINT_DATE_TIME_FORMAT)))
2781                        index = i
2782                        printCount = index + 1
2783                        break
2784
2785                history = pd.concat([tempOld, tempHistory[index:]], ignore_index=True)
2786
2787            else:
2788                history = tempHistory  # if no `--only-missing` key then load full data from server
2789
2790            uLogger.debug("Last 3 rows of received history:\n{}".format(pd.DataFrame.to_string(history[["date", "time", "open", "high", "low", "close", "volume"]][-3:], max_cols=20, index=False)))
2791
2792        if history is not None and not history.empty:
2793            if show:
2794                uLogger.info("Here's requested history between [{}] UTC and [{}] UTC, not-empty candles count: [{}]\n{}".format(
2795                    strStartDate.replace("T", " ").replace("Z", ""), strEndDate.replace("T", " ").replace("Z", ""), len(history[-printCount:]),
2796                    pd.DataFrame.to_string(history[["date", "time", "open", "high", "low", "close", "volume"]][-printCount:], max_cols=20, index=False),
2797                ))
2798
2799        else:
2800            uLogger.warning("Received an empty candles history!")
2801
2802        if self.historyFile is not None:
2803            if history is not None and not history.empty:
2804                history.to_csv(self.historyFile, sep=csvSep, index=False, header=None)
2805                uLogger.info("Ticker [{}], FIGI [{}], tf: [{}], history saved: [{}]".format(self.ticker, self.figi, interval, os.path.abspath(self.historyFile)))
2806
2807            else:
2808                uLogger.warning("Empty history received! File NOT updated: [{}]".format(os.path.abspath(self.historyFile)))
2809
2810        else:
2811            uLogger.debug("--output key is not defined. Parsed history file not saved to file, only Pandas DataFrame returns.")
2812
2813        return history
2814
2815    def LoadHistory(self, filePath: str) -> pd.DataFrame:
2816        """
2817        Load candles history from csv-file and return Pandas DataFrame object.
2818
2819        See also: `History()` and `ShowHistoryChart()` methods.
2820
2821        :param filePath: path to csv-file to open.
2822        """
2823        loadedHistory = None  # init candles data object
2824
2825        uLogger.debug("Loading candles history with PriceGenerator module. Wait, please...")
2826
2827        if os.path.exists(filePath):
2828            loadedHistory = self.priceModel.LoadFromFile(filePath)  # load data and get chain of candles as Pandas DataFrame
2829
2830            tfStr = self.priceModel.FormattedDelta(
2831                self.priceModel.timeframe,
2832                "{days} days {hours}h {minutes}m {seconds}s",
2833            ) if self.priceModel.timeframe >= timedelta(days=1) else self.priceModel.FormattedDelta(
2834                self.priceModel.timeframe,
2835                "{hours}h {minutes}m {seconds}s",
2836            )
2837
2838            if loadedHistory is not None and not loadedHistory.empty:
2839                uLogger.info("Rows count loaded: [{}], detected timeframe of candles: [{}]. Showing some last rows:\n{}".format(
2840                    len(loadedHistory),
2841                    tfStr,
2842                    pd.DataFrame.to_string(loadedHistory[-10:], max_cols=20)),
2843                )
2844
2845            else:
2846                uLogger.warning("It was loaded an empty history! Path: [{}]".format(os.path.abspath(filePath)))
2847
2848        else:
2849            uLogger.error("File with candles history does not exist! Check the path: [{}]".format(filePath))
2850
2851        return loadedHistory
2852
2853    def ShowHistoryChart(self, candles: Union[str, pd.DataFrame] = None, interact: bool = True, openInBrowser: bool = False) -> None:
2854        """
2855        Render an HTML-file with interact or non-interact candlesticks chart. Candles may be path to the csv-file.
2856
2857        Self variable `htmlHistoryFile` can be use as html-file name to save interaction or non-interaction chart.
2858        Default: `index.html` (both for interact and non-interact candlesticks chart).
2859
2860        See also: `History()` and `LoadHistory()` methods.
2861
2862        :param candles: string to csv-file with candles in OHLCV-model or like Pandas Dataframe object.
2863        :param interact: if True (default) then chain of candlesticks will render as interactive Bokeh chart.
2864                         See examples: https://github.com/Tim55667757/PriceGenerator#overriding-parameters
2865                         If False then chain of candlesticks will render as not interactive Google Candlestick chart.
2866                         See examples: https://github.com/Tim55667757/PriceGenerator#statistics-and-chart-on-a-simple-template
2867        :param openInBrowser: if True then immediately open chart in default browser, otherwise only path to
2868                              html-file prints to console. False by default, to avoid issues with `permissions denied` to html-file.
2869        """
2870        if isinstance(candles, str):
2871            self.priceModel.prices = self.LoadHistory(filePath=candles)  # load candles chain from file
2872            self.priceModel.ticker = os.path.basename(candles)  # use filename as ticker name in PriceGenerator
2873
2874        elif isinstance(candles, pd.DataFrame):
2875            self.priceModel.prices = candles  # set candles chain from variable
2876            self.priceModel.ticker = self.ticker  # use current TKSBrokerAPI ticker as ticker name in PriceGenerator
2877
2878            if "datetime" not in candles.columns:
2879                self.priceModel.prices["datetime"] = pd.to_datetime(candles.date + ' ' + candles.time, utc=True)  # PriceGenerator uses "datetime" column with date and time
2880
2881        else:
2882            uLogger.error("`candles` variable must be path string to the csv-file with candles in OHLCV-model or like Pandas Dataframe object!")
2883            raise Exception("Incorrect value")
2884
2885        self.priceModel.horizon = len(self.priceModel.prices)  # use length of candles data as horizon in PriceGenerator
2886
2887        if interact:
2888            uLogger.debug("Rendering interactive candles chart. Wait, please...")
2889
2890            self.priceModel.RenderBokeh(fileName=self.htmlHistoryFile, viewInBrowser=openInBrowser)
2891
2892        else:
2893            uLogger.debug("Rendering non-interactive candles chart. Wait, please...")
2894
2895            self.priceModel.RenderGoogle(fileName=self.htmlHistoryFile, viewInBrowser=openInBrowser)
2896
2897        uLogger.info("Rendered candles chart: [{}]".format(os.path.abspath(self.htmlHistoryFile)))
2898
2899    def Trade(self, operation: str, lots: int = 1, tp: float = 0., sl: float = 0., expDate: str = "Undefined") -> dict:
2900        """
2901        Universal method to create market order and make deal at the current price for current `accountId`. Returns JSON data with response.
2902        If `tp` or `sl` > 0, then in additional will open stop-orders with "TP" and "SL" flags for `stopType` parameter.
2903
2904        See also: `Order()` docstring. More simple methods than `Trade()` are `Buy()` and `Sell()`.
2905
2906        :param operation: string "Buy" or "Sell".
2907        :param lots: volume, integer count of lots >= 1.
2908        :param tp: float > 0, target price for stop-order with "TP" type. It used as take profit parameter `targetPrice` in `self.Order()`.
2909        :param sl: float > 0, target price for stop-order with "SL" type. It used as stop loss parameter `targetPrice` in `self.Order()`.
2910        :param expDate: string "Undefined" by default or local date in future,
2911                        it is a string with format `%Y-%m-%d %H:%M:%S`.
2912        :return: JSON with response from broker server.
2913        """
2914        if self.accountId is None or not self.accountId:
2915            uLogger.error("Variable `accountId` must be defined for using this method!")
2916            raise Exception("Account ID required")
2917
2918        if operation is None or not operation or operation not in ("Buy", "Sell"):
2919            uLogger.error("You must define operation type only one of them: `Buy` or `Sell`!")
2920            raise Exception("Incorrect value")
2921
2922        if lots is None or lots < 1:
2923            uLogger.warning("You must define trade volume > 0: integer count of lots! For current operation lots reset to 1.")
2924            lots = 1
2925
2926        if tp is None or tp < 0:
2927            tp = 0
2928
2929        if sl is None or sl < 0:
2930            sl = 0
2931
2932        if expDate is None or not expDate:
2933            expDate = "Undefined"
2934
2935        if not (self.ticker or self.figi):
2936            uLogger.error("Ticker or FIGI must be defined!")
2937            raise Exception("Ticker or FIGI required")
2938
2939        instrument = self.SearchByTicker(requestPrice=True, debug=False) if self.ticker else self.SearchByFIGI(requestPrice=True, debug=False)
2940        self.ticker = instrument["ticker"]
2941        self.figi = instrument["figi"]
2942
2943        uLogger.debug("Opening [{}] market order: ticker [{}], FIGI [{}], lots [{}], TP [{:.4f}], SL [{:.4f}], expiration date of TP/SL orders [{}]. Wait, please...".format(operation, self.ticker, self.figi, lots, tp, sl, expDate))
2944
2945        openTradeURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/PostOrder"
2946        self.body = str({
2947            "figi": self.figi,
2948            "quantity": str(lots),
2949            "direction": "ORDER_DIRECTION_BUY" if operation == "Buy" else "ORDER_DIRECTION_SELL",  # see: TKS_ORDER_DIRECTIONS
2950            "accountId": str(self.accountId),
2951            "orderType": "ORDER_TYPE_MARKET",  # see: TKS_ORDER_TYPES
2952        })
2953        response = self.SendAPIRequest(openTradeURL, reqType="POST", retry=0, debug=False)
2954
2955        if "orderId" in response.keys():
2956            uLogger.info("[{}] market order [{}] was executed: ticker [{}], FIGI [{}], lots [{}]. Total order price: [{:.4f} {}] (with commission: [{:.2f} {}]). Average price of lot: [{:.2f} {}]".format(
2957                operation, response["orderId"],
2958                self.ticker, self.figi, lots,
2959                NanoToFloat(response["totalOrderAmount"]["units"], response["totalOrderAmount"]["nano"]), response["totalOrderAmount"]["currency"],
2960                NanoToFloat(response["initialCommission"]["units"], response["initialCommission"]["nano"]), response["initialCommission"]["currency"],
2961                NanoToFloat(response["executedOrderPrice"]["units"], response["executedOrderPrice"]["nano"]), response["executedOrderPrice"]["currency"],
2962            ))
2963
2964        else:
2965            uLogger.warning("Not `oK` status received! Market order not executed. See full debug log or try again and open order later.")
2966
2967        if tp > 0:
2968            self.Order(operation="Sell" if operation == "Buy" else "Buy", orderType="Stop", lots=lots, targetPrice=tp, limitPrice=tp, stopType="TP", expDate=expDate)
2969
2970        if sl > 0:
2971            self.Order(operation="Sell" if operation == "Buy" else "Buy", orderType="Stop", lots=lots, targetPrice=sl, limitPrice=sl, stopType="SL", expDate=expDate)
2972
2973        return response
2974
2975    def Buy(self, lots: int = 1, tp: float = 0., sl: float = 0., expDate: str = "Undefined") -> dict:
2976        """
2977        More simple method than `Trade()`. Create `Buy` market order and make deal at the current price. Returns JSON data with response.
2978        If `tp` or `sl` > 0, then in additional will opens stop-orders with "TP" and "SL" flags for `stopType` parameter.
2979
2980        See also: `Order()` and `Trade()` docstrings.
2981
2982        :param lots: volume, integer count of lots >= 1.
2983        :param tp: float > 0, take profit price of stop-order.
2984        :param sl: float > 0, stop loss price of stop-order.
2985        :param expDate: it's a local date in future.
2986                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
2987        :return: JSON with response from broker server.
2988        """
2989        return self.Trade(operation="Buy", lots=lots, tp=tp, sl=sl, expDate=expDate)
2990
2991    def Sell(self, lots: int = 1, tp: float = 0., sl: float = 0., expDate: str = "Undefined") -> dict:
2992        """
2993        More simple method than `Trade()`. Create `Sell` market order and make deal at the current price. Returns JSON data with response.
2994        If `tp` or `sl` > 0, then in additional will open stop-orders with "TP" and "SL" flags for `stopType` parameter.
2995
2996        See also: `Order()` and `Trade()` docstrings.
2997
2998        :param lots: volume, integer count of lots >= 1.
2999        :param tp: float > 0, take profit price of stop-order.
3000        :param sl: float > 0, stop loss price of stop-order.
3001        :param expDate: it's a local date in the future.
3002                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3003        :return: JSON with response from broker server.
3004        """
3005        return self.Trade(operation="Sell", lots=lots, tp=tp, sl=sl, expDate=expDate)
3006
3007    def CloseTrades(self, instruments: list[str], portfolio: dict = None) -> None:
3008        """
3009        Close position of given instruments.
3010
3011        :param instruments: list of instruments defined by tickers or FIGIs that must be closed.
3012        :param portfolio: pre-received dictionary with open trades, returned by `Overview()` method.
3013                         This avoids unnecessary downloading data from the server.
3014        """
3015        if instruments is None or not instruments:
3016            uLogger.error("List of tickers or FIGIs must be defined for using this method!")
3017            raise Exception("Ticker or FIGI required")
3018
3019        if isinstance(instruments, str):
3020            instruments = [instruments]
3021
3022        uniqueInstruments = self.GetUniqueFIGIs(instruments)
3023        if uniqueInstruments:
3024            if portfolio is None or not portfolio:
3025                portfolio = self.Overview(show=False)
3026
3027            allOpened = [item["figi"] for iType in TKS_INSTRUMENTS for item in portfolio["stat"][iType]]
3028            uLogger.debug("All opened instruments by it's FIGI: {}".format(", ".join(allOpened)))
3029
3030            for self.figi in uniqueInstruments:
3031                if self.figi not in allOpened:
3032                    uLogger.warning("Instrument with FIGI [{}] not in open positions list!".format(self.figi))
3033                    continue
3034
3035                # search open trade info about instrument by ticker:
3036                instrument = {}
3037                for iType in TKS_INSTRUMENTS:
3038                    if instrument:
3039                        break
3040
3041                    for item in portfolio["stat"][iType]:
3042                        if item["figi"] == self.figi:
3043                            instrument = item
3044                            break
3045
3046                if instrument:
3047                    self.ticker = instrument["ticker"]
3048                    self.figi = instrument["figi"]
3049
3050                    uLogger.debug("Closing trade of instrument: ticker [{}], FIGI[{}], lots [{}]{}. Wait, please...".format(
3051                        self.ticker,
3052                        self.figi,
3053                        int(instrument["volume"]),
3054                        ", blocked [{}]".format(instrument["blocked"]) if instrument["blocked"] > 0 else "",
3055                    ))
3056
3057                    tradeLots = abs(instrument["lots"]) - instrument["blocked"]  # available volumes in lots for close operation
3058
3059                    if tradeLots > 0:
3060                        if instrument["blocked"] > 0:
3061                            uLogger.warning("Just for your information: there are [{}] lots blocked for instrument [{}]! Available only [{}] lots to closing trade.".format(
3062                                instrument["blocked"],
3063                                self.ticker,
3064                                tradeLots,
3065                            ))
3066
3067                        # if direction is "Long" then we need sell, if direction is "Short" then we need buy:
3068                        self.Trade(operation="Sell" if instrument["direction"] == "Long" else "Buy", lots=tradeLots)
3069
3070                    else:
3071                        uLogger.warning("There are no available lots for instrument [{}] to closing trade at this moment! Try again later or cancel some orders.".format(self.ticker))
3072
3073    def CloseAllTrades(self, iType: str, portfolio: dict = None) -> None:
3074        """
3075        Close all positions of given instruments with defined type.
3076
3077        :param iType: type of the instruments that be closed, it must be one of supported types in TKS_INSTRUMENTS list.
3078        :param portfolio: pre-received dictionary with open trades, returned by `Overview()` method.
3079                         This avoids unnecessary downloading data from the server.
3080        """
3081        if iType not in TKS_INSTRUMENTS:
3082            uLogger.warning("Type of the instrument must be one of supported types: {}. Given: [{}]".format(", ".join(TKS_INSTRUMENTS), iType))
3083
3084        else:
3085            if portfolio is None or not portfolio:
3086                portfolio = self.Overview(show=False)
3087
3088            tickers = [item["ticker"] for item in portfolio["stat"][iType]]
3089            uLogger.debug("Instrument tickers with type [{}] that will be closed: {}".format(iType, tickers))
3090
3091            if tickers and portfolio:
3092                self.CloseTrades(tickers, portfolio)
3093
3094            else:
3095                uLogger.info("Instrument tickers with type [{}] not found, nothing to close.".format(iType))
3096
3097    def Order(self, operation: str, orderType: str, lots: int, targetPrice: float, limitPrice: float = 0., stopType: str = "Limit", expDate: str = "Undefined") -> dict:
3098        """
3099        Universal method to create market or limit orders with all available parameters for current `accountId`.
3100        See more simple methods: `BuyLimit()`, `BuyStop()`, `SellLimit()`, `SellStop()`.
3101
3102        If orderType is "Limit" then create pending limit-order below current price if operation is "Buy" and above
3103        current price if operation is "Sell". A limit order has no expiration date, it lasts until the end of the trading day.
3104
3105        Warning! If you try to create limit-order above current price if "Buy" or below current price if "Sell"
3106        then broker immediately open market order as you can do simple --buy or --sell operations!
3107
3108        If orderType is "Stop" then creates stop-order with any direction "Buy" or "Sell".
3109        When current price will go up or down to target price value then broker opens a limit order.
3110        Stop-order is opened with unlimited expiration date by default, or you can define expiration date with expDate parameter.
3111
3112        Only one attempt and no retry for opens order. If network issue occurred you can create new request.
3113
3114        :param operation: string "Buy" or "Sell".
3115        :param orderType: string "Limit" or "Stop".
3116        :param lots: volume, integer count of lots >= 1.
3117        :param targetPrice: target price > 0. This is open trade price for limit order.
3118        :param limitPrice: limit price >= 0. This parameter only makes sense for stop-order. If limitPrice = 0, then it set as targetPrice.
3119                           Broker will creates limit-order with price equal to limitPrice, when current price goes to target price of stop-order.
3120        :param stopType: string "Limit" by default. This parameter only makes sense for stop-order. There are 3 stop-order types
3121                         "SL", "TP", "Limit" for "Stop loss", "Take profit" and "Stop limit" types accordingly.
3122                         Stop loss order always executed by market price.
3123        :param expDate: string "Undefined" by default or local date in future.
3124                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3125                        This date is converting to UTC format for server. This parameter only makes sense for stop-order.
3126                        A limit order has no expiration date, it lasts until the end of the trading day.
3127        :return: JSON with response from broker server.
3128        """
3129        if self.accountId is None or not self.accountId:
3130            uLogger.error("Variable `accountId` must be defined for using this method!")
3131            raise Exception("Account ID required")
3132
3133        if operation is None or not operation or operation not in ("Buy", "Sell"):
3134            uLogger.error("You must define operation type only one of them: `Buy` or `Sell`!")
3135            raise Exception("Incorrect value")
3136
3137        if orderType is None or not orderType or orderType not in ("Limit", "Stop"):
3138            uLogger.error("You must define order type only one of them: `Limit` or `Stop`!")
3139            raise Exception("Incorrect value")
3140
3141        if lots is None or lots < 1:
3142            uLogger.error("You must define trade volume > 0: integer count of lots!")
3143            raise Exception("Incorrect value")
3144
3145        if targetPrice is None or targetPrice <= 0:
3146            uLogger.error("Target price for limit-order must be greater than 0!")
3147            raise Exception("Incorrect value")
3148
3149        if limitPrice is None or limitPrice <= 0:
3150            limitPrice = targetPrice
3151
3152        if stopType is None or not stopType or stopType not in ("SL", "TP", "Limit"):
3153            stopType = "Limit"
3154
3155        if expDate is None or not expDate:
3156            expDate = "Undefined"
3157
3158        if not (self.ticker or self.figi):
3159            uLogger.error("Tocker or FIGI must be defined!")
3160            raise Exception("Ticker or FIGI required")
3161
3162        response = {}
3163        instrument = self.SearchByTicker(requestPrice=True, debug=False) if self.ticker else self.SearchByFIGI(requestPrice=True, debug=False)
3164        self.ticker = instrument["ticker"]
3165        self.figi = instrument["figi"]
3166
3167        if orderType == "Limit":
3168            uLogger.debug(
3169                "Creating pending limit-order: ticker [{}], FIGI [{}], action [{}], lots [{}] and the target price [{:.2f} {}]. Wait, please...".format(
3170                    self.ticker, self.figi,
3171                    operation, lots, targetPrice, instrument["currency"],
3172                ))
3173
3174            openOrderURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/PostOrder"
3175            self.body = str({
3176                "figi": self.figi,
3177                "quantity": str(lots),
3178                "price": FloatToNano(targetPrice),
3179                "direction": "ORDER_DIRECTION_BUY" if operation == "Buy" else "ORDER_DIRECTION_SELL",  # see: TKS_ORDER_DIRECTIONS
3180                "accountId": str(self.accountId),
3181                "orderType": "ORDER_TYPE_LIMIT",  # see: TKS_ORDER_TYPES
3182            })
3183            response = self.SendAPIRequest(openOrderURL, reqType="POST", retry=0, debug=False)
3184
3185            if "orderId" in response.keys():
3186                uLogger.info(
3187                    "Limit-order [{}] was created: ticker [{}], FIGI [{}], action [{}], lots [{}], target price [{:.2f} {}]".format(
3188                        response["orderId"],
3189                        self.ticker, self.figi,
3190                        operation, lots, targetPrice, instrument["currency"],
3191                    ))
3192
3193                if "lastPrice" in instrument["currentPrice"].keys() and instrument["currentPrice"]["lastPrice"]:
3194                    if operation == "Buy" and targetPrice > instrument["currentPrice"]["lastPrice"]:
3195                        uLogger.warning("Your order was executed as a market order, not as a limit order! Comment: because your target price [{:.2f} {}] was higher than current price [{:.2f} {}] broker immediately opened `Buy` market order, such as if you did simple `--buy` operation.".format(
3196                            targetPrice, instrument["currency"],
3197                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3198                        ))
3199
3200                    if operation == "Sell" and targetPrice < instrument["currentPrice"]["lastPrice"]:
3201                        uLogger.warning("Your order was executed as a market order, not as a limit order! Comment: because your target price [{:.2f} {}] was lower than current price [{:.2f} {}] broker immediately opened `Sell` market order, such as if you did simple `--sell` operation.".format(
3202                            targetPrice, instrument["currency"],
3203                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3204                        ))
3205
3206            else:
3207                uLogger.warning("Not `oK` status received! Limit order not opened. See full debug log or try again and open order later.")
3208
3209        if orderType == "Stop":
3210            uLogger.debug(
3211                "Creating stop-order: ticker [{}], FIGI [{}], action [{}], lots [{}], target price [{:.2f} {}], limit price [{:.2f} {}], stop-order type [{}] and local expiration date [{}]. Wait, please...".format(
3212                    self.ticker, self.figi,
3213                    operation, lots,
3214                    targetPrice, instrument["currency"],
3215                    limitPrice, instrument["currency"],
3216                    stopType, expDate,
3217                ))
3218
3219            openOrderURL = self.server + r"/tinkoff.public.invest.api.contract.v1.StopOrdersService/PostStopOrder"
3220            expDateUTC = "" if expDate == "Undefined" else datetime.strptime(expDate, TKS_PRINT_DATE_TIME_FORMAT).replace(tzinfo=tzlocal()).astimezone(tzutc()).strftime(TKS_DATE_TIME_FORMAT_EXT)
3221            stopOrderType = "STOP_ORDER_TYPE_STOP_LOSS" if stopType == "SL" else "STOP_ORDER_TYPE_TAKE_PROFIT" if stopType == "TP" else "STOP_ORDER_TYPE_STOP_LIMIT"
3222
3223            body = {
3224                "figi": self.figi,
3225                "quantity": str(lots),
3226                "price": FloatToNano(limitPrice),
3227                "stopPrice": FloatToNano(targetPrice),
3228                "direction": "STOP_ORDER_DIRECTION_BUY" if operation == "Buy" else "STOP_ORDER_DIRECTION_SELL",  # see: TKS_STOP_ORDER_DIRECTIONS
3229                "accountId": str(self.accountId),
3230                "expirationType": "STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE" if expDateUTC else "STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL",  # see: TKS_STOP_ORDER_EXPIRATION_TYPES
3231                "stopOrderType": stopOrderType,  # see: TKS_STOP_ORDER_TYPES
3232            }
3233
3234            if expDateUTC:
3235                body["expireDate"] = expDateUTC
3236
3237            self.body = str(body)
3238            response = self.SendAPIRequest(openOrderURL, reqType="POST", retry=0, debug=False)
3239
3240            if "stopOrderId" in response.keys():
3241                uLogger.info(
3242                    "Stop-order [{}] was created: ticker [{}], FIGI [{}], action [{}], lots [{}], target price [{:.2f} {}], limit price [{:.2f} {}], stop-order type [{}] and expiration date in UTC [{}]".format(
3243                        response["stopOrderId"],
3244                        self.ticker, self.figi,
3245                        operation, lots,
3246                        targetPrice, instrument["currency"],
3247                        limitPrice, instrument["currency"],
3248                        TKS_STOP_ORDER_TYPES[stopOrderType],
3249                        datetime.strptime(expDateUTC, TKS_DATE_TIME_FORMAT_EXT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT) if expDateUTC else TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED"],
3250                    ))
3251
3252                if "lastPrice" in instrument["currentPrice"].keys() and instrument["currentPrice"]["lastPrice"]:
3253                    if operation == "Buy" and targetPrice < instrument["currentPrice"]["lastPrice"] and stopType != "TP":
3254                        uLogger.warning("The broker will cancel this order after some time. Comment: you placed the wrong stop order because the target buy price [{:.2f} {}] is lower than the current price [{:.2f} {}]. Also try to set up order type as `TP` if you want to place stop order at that price.".format(
3255                            targetPrice, instrument["currency"],
3256                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3257                        ))
3258
3259                    if operation == "Sell" and targetPrice > instrument["currentPrice"]["lastPrice"] and stopType != "TP":
3260                        uLogger.warning("The broker will cancel this order after some time. Comment: you placed the wrong stop order because the target sell price [{:.2f} {}] is higher than the current price [{:.2f} {}]. Also try to set up order type as `TP` if you want to place stop order at that price.".format(
3261                            targetPrice, instrument["currency"],
3262                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3263                        ))
3264
3265            else:
3266                uLogger.warning("Not `oK` status received! Stop order not opened. See full debug log or try again and open order later.")
3267
3268        return response
3269
3270    def BuyLimit(self, lots: int, targetPrice: float) -> dict:
3271        """
3272        Create pending `Buy` limit-order (below current price). You must specify only 2 parameters:
3273        `lots` and `target price` to open buy limit-order. If you try to create buy limit-order above current price then
3274        broker immediately open `Buy` market order, such as if you do simple `--buy` operation!
3275        See also: `Order()` docstring.
3276
3277        :param lots: volume, integer count of lots >= 1.
3278        :param targetPrice: target price > 0. This is open trade price for limit order.
3279        :return: JSON with response from broker server.
3280        """
3281        return self.Order(operation="Buy", orderType="Limit", lots=lots, targetPrice=targetPrice)
3282
3283    def BuyStop(self, lots: int, targetPrice: float, limitPrice: float = 0., stopType: str = "Limit", expDate: str = "Undefined") -> dict:
3284        """
3285        Create `Buy` stop-order. You must specify at least 2 parameters: `lots` `target price` to open buy stop-order.
3286        In additional you can specify 3 parameters for buy stop-order: `limit price` >=0, `stop type` = Limit|SL|TP,
3287        `expiration date` = Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`. When current price will go up or down to
3288        target price value then broker opens a limit order. See also: `Order()` docstring.
3289
3290        :param lots: volume, integer count of lots >= 1.
3291        :param targetPrice: target price > 0. This is trigger price for buy stop-order.
3292        :param limitPrice: limit price >= 0 (limitPrice = targetPrice if limitPrice is 0). Broker will creates limit-order
3293                           with price equal to limitPrice, when current price goes to target price of buy stop-order.
3294        :param stopType: string "Limit" by default. There are 3 stop-order types "SL", "TP", "Limit"
3295                         for "Stop loss", "Take profit" and "Stop limit" types accordingly.
3296        :param expDate: string "Undefined" by default or local date in future.
3297                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3298                        This date is converting to UTC format for server.
3299        :return: JSON with response from broker server.
3300        """
3301        return self.Order(operation="Buy", orderType="Stop", lots=lots, targetPrice=targetPrice, limitPrice=limitPrice, stopType=stopType, expDate=expDate)
3302
3303    def SellLimit(self, lots: int, targetPrice: float) -> dict:
3304        """
3305        Create pending `Sell` limit-order (above current price). You must specify only 2 parameters:
3306        `lots` and `target price` to open sell limit-order. If you try to create sell limit-order below current price then
3307        broker immediately open `Sell` market order, such as if you do simple `--sell` operation!
3308        See also: `Order()` docstring.
3309
3310        :param lots: volume, integer count of lots >= 1.
3311        :param targetPrice: target price > 0. This is open trade price for limit order.
3312        :return: JSON with response from broker server.
3313        """
3314        return self.Order(operation="Sell", orderType="Limit", lots=lots, targetPrice=targetPrice)
3315
3316    def SellStop(self, lots: int, targetPrice: float, limitPrice: float = 0., stopType: str = "Limit", expDate: str = "Undefined") -> dict:
3317        """
3318        Create `Sell` stop-order. You must specify at least 2 parameters: `lots` `target price` to open sell stop-order.
3319        In additional you can specify 3 parameters for sell stop-order: `limit price` >=0, `stop type` = Limit|SL|TP,
3320        `expiration date` = Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`. When current price will go up or down to
3321        target price value then broker opens a limit order. See also: `Order()` docstring.
3322
3323        :param lots: volume, integer count of lots >= 1.
3324        :param targetPrice: target price > 0. This is trigger price for sell stop-order.
3325        :param limitPrice: limit price >= 0 (limitPrice = targetPrice if limitPrice is 0). Broker will creates limit-order
3326                           with price equal to limitPrice, when current price goes to target price of sell stop-order.
3327        :param stopType: string "Limit" by default. There are 3 stop-order types "SL", "TP", "Limit"
3328                         for "Stop loss", "Take profit" and "Stop limit" types accordingly.
3329        :param expDate: string "Undefined" by default or local date in future.
3330                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3331                        This date is converting to UTC format for server.
3332        :return: JSON with response from broker server.
3333        """
3334        return self.Order(operation="Sell", orderType="Stop", lots=lots, targetPrice=targetPrice, limitPrice=limitPrice, stopType=stopType, expDate=expDate)
3335
3336    def CloseOrders(self, orderIDs: list, allOrdersIDs: list = None, allStopOrdersIDs: list = None) -> None:
3337        """
3338        Cancel order or list of orders by its `orderId` or `stopOrderId` for current `accountId`.
3339
3340        :param orderIDs: list of integers with `orderId` or `stopOrderId`.
3341        :param allOrdersIDs: pre-received lists of all active pending orders.
3342                             This avoids unnecessary downloading data from the server.
3343        :param allStopOrdersIDs: pre-received lists of all active stop orders.
3344        """
3345        if self.accountId is None or not self.accountId:
3346            uLogger.error("Variable `accountId` must be defined for using this method!")
3347            raise Exception("Account ID required")
3348
3349        if orderIDs:
3350            if allOrdersIDs is None or not allOrdersIDs:
3351                rawOrders = self.RequestPendingOrders()
3352                allOrdersIDs = [item["orderId"] for item in rawOrders]  # all pending orders ID
3353
3354            if allStopOrdersIDs is None or not allStopOrdersIDs:
3355                rawStopOrders = self.RequestStopOrders()
3356                allStopOrdersIDs = [item["stopOrderId"] for item in rawStopOrders]  # all stop orders ID
3357
3358            for orderID in orderIDs:
3359                idInPendingOrders = orderID in allOrdersIDs
3360                idInStopOrders = orderID in allStopOrdersIDs
3361
3362                if not (idInPendingOrders or idInStopOrders):
3363                    uLogger.warning("Order not found by ID: [{}]. Maybe cancelled already? Check it with `--overview` key.".format(orderID))
3364                    continue
3365
3366                else:
3367                    if idInPendingOrders:
3368                        uLogger.debug("Cancelling pending order with ID: [{}]. Wait, please...".format(orderID))
3369
3370                        # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/OrdersService/OrdersService_CancelOrder
3371                        self.body = str({"accountId": self.accountId, "orderId": orderID})
3372                        closeURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/CancelOrder"
3373                        responseJSON = self.SendAPIRequest(closeURL, reqType="POST")
3374
3375                        if responseJSON and "time" in responseJSON.keys() and responseJSON["time"]:
3376                            uLogger.debug("Success time marker received from server: [{}] (UTC)".format(responseJSON["time"]))
3377                            uLogger.info("Pending order with ID [{}] successfully cancel".format(orderID))
3378
3379                        else:
3380                            uLogger.warning("Unknown issue occurred when cancelling pending order with ID: [{}]. Check ID and try again.".format(orderID))
3381
3382                    elif idInStopOrders:
3383                        uLogger.debug("Cancelling stop order with ID: [{}]. Wait, please...".format(orderID))
3384
3385                        # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/StopOrdersService/StopOrdersService_CancelStopOrder
3386                        self.body = str({"accountId": self.accountId, "stopOrderId": orderID})
3387                        closeURL = self.server + r"/tinkoff.public.invest.api.contract.v1.StopOrdersService/CancelStopOrder"
3388                        responseJSON = self.SendAPIRequest(closeURL, reqType="POST")
3389
3390                        if responseJSON and "time" in responseJSON.keys() and responseJSON["time"]:
3391                            uLogger.debug("Success time marker received from server: [{}] (UTC)".format(responseJSON["time"]))
3392                            uLogger.info("Stop order with ID [{}] successfully cancel".format(orderID))
3393
3394                        else:
3395                            uLogger.warning("Unknown issue occurred when cancelling stop order with ID: [{}]. Check ID and try again.".format(orderID))
3396
3397                    else:
3398                        continue
3399
3400    def CloseAllOrders(self) -> None:
3401        """
3402        Gets a list of open pending and stop orders and cancel it all.
3403        """
3404        rawOrders = self.RequestPendingOrders()
3405        allOrdersIDs = [item["orderId"] for item in rawOrders]  # all pending orders ID
3406        lenOrders = len(allOrdersIDs)
3407
3408        rawStopOrders = self.RequestStopOrders()
3409        allStopOrdersIDs = [item["stopOrderId"] for item in rawStopOrders]  # all stop orders ID
3410        lenSOrders = len(allStopOrdersIDs)
3411
3412        if lenOrders > 0 or lenSOrders > 0:
3413            uLogger.info("Found: [{}] opened pending and [{}] stop orders. Let's trying to cancel it all. Wait, please...".format(lenOrders, lenSOrders))
3414
3415            self.CloseOrders(allOrdersIDs + allStopOrdersIDs, allOrdersIDs, allStopOrdersIDs)
3416
3417        else:
3418            uLogger.info("Orders not found, nothing to cancel.")
3419
3420    def CloseAll(self, *args) -> None:
3421        """
3422        Close all available (not blocked) opened trades and orders.
3423
3424        Also, you can select one or more keywords case-insensitive:
3425        `orders`, `shares`, `bonds`, `etfs` and `futures` from `TKS_INSTRUMENTS` enum to specify trades type.
3426
3427        Currency positions you must close manually using buy or sell operations, `CloseTrades()` or `CloseAllTrades()` methods.
3428        """
3429        overview = self.Overview(show=False)  # get all open trades info
3430
3431        if len(args) == 0:
3432            uLogger.debug("Closing all available (not blocked) opened trades and orders. Currency positions you must closes manually using buy or sell operations! Wait, please...")
3433            self.CloseAllOrders()  # close all pending and stop orders
3434
3435            for iType in TKS_INSTRUMENTS:
3436                if iType != "Currencies":
3437                    self.CloseAllTrades(iType, overview)  # close all positions of instruments with same type without currencies
3438
3439        else:
3440            uLogger.debug("Closing all available {}. Currency positions you must closes manually using buy or sell operations! Wait, please...".format(list(args)))
3441            lowerArgs = [x.lower() for x in args]
3442
3443            if "orders" in lowerArgs:
3444                self.CloseAllOrders()  # close all pending and stop orders
3445
3446            for iType in TKS_INSTRUMENTS:
3447                if iType.lower() in lowerArgs and iType != "Currencies":
3448                    self.CloseAllTrades(iType, overview)  # close all positions of instruments with same type without currencies
3449
3450    @staticmethod
3451    def ParseOrderParameters(operation, **inputParameters):
3452        """
3453        Parse input dictionary of strings with order parameters and return dictionary with parameters to open all orders.
3454
3455        :param operation: string "Buy" or "Sell".
3456        :param inputParameters: this is dict of strings that looks like this
3457               `{"lots": "L_int,...", "prices": "P_float,..."}` where
3458               "lots" key: one or more lot values (integer numbers) to open with every limit-order
3459               "prices" key: one or more prices to open limit-orders
3460               Counts of values in lots and prices lists must be equals!
3461        :return: list of dictionaries with all lots and prices to open orders that looks like this `[{"lot": lots_1, "price": price_1}, {...}, ...]`
3462        """
3463        # TODO: update order grid work with api v2
3464        pass
3465        # uLogger.debug("Input parameters: {}".format(inputParameters))
3466        #
3467        # if operation is None or not operation or operation not in ("Buy", "Sell"):
3468        #     uLogger.error("You must define operation type: 'Buy' or 'Sell'!")
3469        #     raise Exception("Incorrect value")
3470        #
3471        # if "l" in inputParameters.keys():
3472        #     inputParameters["lots"] = inputParameters.pop("l")
3473        #
3474        # if "p" in inputParameters.keys():
3475        #     inputParameters["prices"] = inputParameters.pop("p")
3476        #
3477        # if "lots" not in inputParameters.keys() or "prices" not in inputParameters.keys():
3478        #     uLogger.error("Both of 'lots' and 'prices' keys must be define to open grid orders!")
3479        #     raise Exception("Incorrect value")
3480        #
3481        # lots = [int(item.strip()) for item in inputParameters["lots"].split(",")]
3482        # prices = [float(item.strip()) for item in inputParameters["prices"].split(",")]
3483        #
3484        # if len(lots) != len(prices):
3485        #     uLogger.error("'lots' and 'prices' lists must have equal length of values!")
3486        #     raise Exception("Incorrect value")
3487        #
3488        # uLogger.debug("Extracted parameters for orders:")
3489        # uLogger.debug("lots = {}".format(lots))
3490        # uLogger.debug("prices = {}".format(prices))
3491        #
3492        # # list of dictionaries with order's parameters: [{"lot": lots_1, "price": price_1}, {...}, ...]
3493        # result = [{"lot": lots[item], "price": prices[item]} for item in range(len(prices))]
3494        # uLogger.debug("Order parameters: {}".format(result))
3495        #
3496        # return result
3497
3498    def IsInPortfolio(self, portfolio: dict = None) -> bool:
3499        """
3500        Checks if instrument is in the user's portfolio. Instrument must be defined by `ticker` (highly priority) or `figi`.
3501
3502        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3503        :return: `True` if portfolio contains open position with given instrument, `False` otherwise.
3504        """
3505        result = False
3506        msg = "Instrument not defined!"
3507
3508        if portfolio is None or not portfolio:
3509            portfolio = self.Overview(show=False)
3510
3511        if self.ticker:
3512            uLogger.debug("Searching instrument with ticker [{}] throwout opened positions...".format(self.ticker))
3513            msg = "Instrument with ticker [{}] is not present in open positions".format(self.ticker)
3514
3515            for iType in TKS_INSTRUMENTS:
3516                for instrument in portfolio["stat"][iType]:
3517                    if instrument["ticker"] == self.ticker:
3518                        result = True
3519                        msg = "Instrument with ticker [{}] is present in open positions".format(self.ticker)
3520                        break
3521
3522        elif self.figi:
3523            uLogger.debug("Searching instrument with FIGI [{}] throwout opened positions...".format(self.figi))
3524            msg = "Instrument with FIGI [{}] is not present in open positions".format(self.figi)
3525
3526            for iType in TKS_INSTRUMENTS:
3527                for instrument in portfolio["stat"][iType]:
3528                    if instrument["figi"] == self.figi:
3529                        result = True
3530                        msg = "Instrument with FIGI [{}] is present in open positions".format(self.figi)
3531                        break
3532
3533        else:
3534            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3535
3536        uLogger.debug(msg)
3537
3538        return result
3539
3540    def GetInstrumentFromPortfolio(self, portfolio: dict = None) -> dict:
3541        """
3542        Returns instrument is in the user's portfolio if it presents there.
3543        Instrument must be defined by `ticker` (highly priority) or `figi`.
3544
3545        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3546        :return: dict with instrument if portfolio contains open position with this instrument, `None` otherwise.
3547        """
3548        result = None
3549        msg = "Instrument not defined!"
3550
3551        if portfolio is None or not portfolio:
3552            portfolio = self.Overview(show=False)
3553
3554        if self.ticker:
3555            uLogger.debug("Searching instrument with ticker [{}] throwout opened positions...".format(self.ticker))
3556            msg = "Instrument with ticker [{}] is not present in open positions".format(self.ticker)
3557
3558            for iType in TKS_INSTRUMENTS:
3559                for instrument in portfolio["stat"][iType]:
3560                    if instrument["ticker"] == self.ticker:
3561                        result = instrument
3562                        msg = "Instrument with ticker [{}] and FIGI [{}] is present in open positions".format(self.ticker, instrument["figi"])
3563                        break
3564
3565        elif self.figi:
3566            uLogger.debug("Searching instrument with FIGI [{}] throwout opened positions...".format(self.figi))
3567            msg = "Instrument with FIGI [{}] is not present in open positions".format(self.figi)
3568
3569            for iType in TKS_INSTRUMENTS:
3570                for instrument in portfolio["stat"][iType]:
3571                    if instrument["figi"] == self.figi:
3572                        result = instrument
3573                        msg = "Instrument with ticker [{}] and FIGI [{}] is present in open positions".format(instrument["ticker"], self.figi)
3574                        break
3575
3576        else:
3577            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3578
3579        uLogger.debug(msg)
3580
3581        return result
3582
3583    def RequestLimits(self) -> dict:
3584        """
3585        Method for obtaining the available funds for withdrawal for current `accountId`.
3586
3587        See also:
3588        - REST API for limits: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetWithdrawLimits
3589        - `OverviewLimits()` method
3590
3591        :return: dict with raw data from server that contains free funds for withdrawal. Example of dict:
3592                 `{"money": [{"currency": "rub", "units": "100", "nano": 290000000}, {...}], "blocked": [...], "blockedGuarantee": [...]}`.
3593                 Here `money` is an array of portfolio currency positions, `blocked` is an array of blocked currency
3594                 positions of the portfolio and `blockedGuarantee` is locked money under collateral for futures.
3595        """
3596        if self.accountId is None or not self.accountId:
3597            uLogger.error("Variable `accountId` must be defined for using this method!")
3598            raise Exception("Account ID required")
3599
3600        uLogger.debug("Requesting current available funds for withdrawal. Wait, please...")
3601
3602        self.body = str({"accountId": self.accountId})
3603        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetWithdrawLimits"
3604        rawLimits = self.SendAPIRequest(portfolioURL, reqType="POST")
3605
3606        uLogger.debug("Records about available funds for withdrawal successfully received")
3607
3608        return rawLimits
3609
3610    def OverviewLimits(self, show: bool = False) -> dict:
3611        """
3612        Method for parsing and show table with available funds for withdrawal for current `accountId`.
3613
3614        See also: `RequestLimits()`.
3615
3616        :param show: if `False` then only dictionary returns, if `True` then also print withdrawal limits to log.
3617        :return: dict with raw parsed data from server and some calculated statistics about it.
3618        """
3619        if self.accountId is None or not self.accountId:
3620            uLogger.error("Variable `accountId` must be defined for using this method!")
3621            raise Exception("Account ID required")
3622
3623        rawLimits = self.RequestLimits()  # raw response with current available funds for withdrawal
3624
3625        view = {
3626            "rawLimits": rawLimits,
3627            "limits": {  # parsed data for every currency:
3628                "money": {  # this is an array of portfolio currency positions
3629                    item["currency"]: NanoToFloat(item["units"], item["nano"]) for item in rawLimits["money"]
3630                },
3631                "blocked": {  # this is an array of blocked currency
3632                    item["currency"]: NanoToFloat(item["units"], item["nano"]) for item in rawLimits["blocked"]
3633                },
3634                "blockedGuarantee": {  # this is locked money under collateral for futures
3635                    item["currency"]: NanoToFloat(item["units"], item["nano"]) for item in rawLimits["blockedGuarantee"]
3636                },
3637            },
3638        }
3639
3640        # --- Prepare text table with limits in human-readable format:
3641        if show:
3642            info = [
3643                "# Withdrawal limits\n\n",
3644                "* **Actual date:** [{} UTC]\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
3645                "* **Account ID:** [{}]\n".format(self.accountId),
3646            ]
3647
3648            if view["limits"]["money"]:
3649                info.extend([
3650                    "\n| Currencies | Total         | Available for withdrawal | Blocked for trade | Futures guarantee |\n",
3651                    "|------------|---------------|--------------------------|-------------------|-------------------|\n",
3652                ])
3653
3654            else:
3655                info.append("\nNo withdrawal limits\n")
3656
3657            for curr in view["limits"]["money"].keys():
3658                blocked = view["limits"]["blocked"][curr] if curr in view["limits"]["blocked"].keys() else 0
3659                blockedGuarantee = view["limits"]["blockedGuarantee"][curr] if curr in view["limits"]["blockedGuarantee"].keys() else 0
3660                availableMoney = view["limits"]["money"][curr] - (blocked + blockedGuarantee)
3661
3662                infoStr = "| {:<10} | {:<13} | {:<24} | {:<17} | {:<17} |\n".format(
3663                    "[{}]".format(curr),
3664                    "{:.2f}".format(view["limits"]["money"][curr]),
3665                    "{:.2f}".format(availableMoney),
3666                    "{:.2f}".format(view["limits"]["blocked"][curr]) if curr in view["limits"]["blocked"].keys() else "—",
3667                    "{:.2f}".format(view["limits"]["blockedGuarantee"][curr]) if curr in view["limits"]["blockedGuarantee"].keys() else "—",
3668                )
3669
3670                if curr == "rub":
3671                    info.insert(5, infoStr)  # hack: insert "rub" at the first position in table and after headers
3672
3673                else:
3674                    info.append(infoStr)
3675
3676            infoText = "".join(info)
3677
3678            uLogger.info(infoText)
3679
3680            if self.withdrawalLimitsFile:
3681                with open(self.withdrawalLimitsFile, "w", encoding="UTF-8") as fH:
3682                    fH.write(infoText)
3683
3684                uLogger.info("Client's withdrawal limits was saved to file: [{}]".format(os.path.abspath(self.withdrawalLimitsFile)))
3685
3686        return view
3687
3688    def RequestAccounts(self) -> dict:
3689        """
3690        Method for requesting all brokerage accounts (`accountId`s) of current user detected by `token`.
3691
3692        See also:
3693        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetAccounts
3694        - What does account fields mean: https://tinkoff.github.io/investAPI/users/#account
3695        - `OverviewUserInfo()` method
3696
3697        :return: dict with raw data from server that contains accounts info. Example of dict:
3698                 `{"accounts": [{"id": "20000xxxxx", "type": "ACCOUNT_TYPE_TINKOFF", "name": "TKSBrokerAPI account",
3699                   "status": "ACCOUNT_STATUS_OPEN", "openedDate": "2018-05-23T00:00:00Z",
3700                   "closedDate": "1970-01-01T00:00:00Z", "accessLevel": "ACCOUNT_ACCESS_LEVEL_FULL_ACCESS"}, ...]}`.
3701                 If `closedDate="1970-01-01T00:00:00Z"` it means that account is active now.
3702        """
3703        uLogger.debug("Requesting all brokerage accounts of current user detected by its token. Wait, please...")
3704
3705        self.body = str({})
3706        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetAccounts"
3707        rawAccounts = self.SendAPIRequest(portfolioURL, reqType="POST")
3708
3709        uLogger.debug("Records about available accounts successfully received")
3710
3711        return rawAccounts
3712
3713    def RequestUserInfo(self) -> dict:
3714        """
3715        Method for requesting common user's information.
3716
3717        See also:
3718        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetInfo
3719        - What does user info fields mean: https://tinkoff.github.io/investAPI/users/#getinforequest
3720        - What does `qualified_for_work_with` field mean: https://tinkoff.github.io/investAPI/faq_users/#qualified_for_work_with
3721        - `OverviewUserInfo()` method
3722
3723        :return: dict with raw data from server that contains user's information. Example of dict:
3724                 `{"premStatus": true, "qualStatus": false, "qualifiedForWorkWith": ["bond", "foreign_shares", "leverage",
3725                   "russian_shares", "structured_income_bonds"], "tariff": "premium"}`.
3726        """
3727        uLogger.debug("Requesting common user's information. Wait, please...")
3728
3729        self.body = str({})
3730        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetInfo"
3731        rawUserInfo = self.SendAPIRequest(portfolioURL, reqType="POST")
3732
3733        uLogger.debug("Records about current user successfully received")
3734
3735        return rawUserInfo
3736
3737    def RequestMarginStatus(self, accountId: str = None) -> dict:
3738        """
3739        Method for requesting margin calculation for defined account ID.
3740
3741        See also:
3742        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetMarginAttributes
3743        - What does margin fields mean: https://tinkoff.github.io/investAPI/users/#getmarginattributesresponse
3744        - `OverviewUserInfo()` method
3745
3746        :param accountId: string with numeric account ID. If `None`, then used class field `accountId`.
3747        :return: dict with raw data from server that contains margin calculation. If margin is disabled then returns empty dict.
3748                 Example of responses:
3749                 status code 400: `{"code": 3, "message": "account margin status is disabled", "description": "30051" }`, returns: `{}`.
3750                 status code 200: `{"liquidPortfolio": {"currency": "rub", "units": "7175", "nano": 560000000},
3751                                    "startingMargin": {"currency": "rub", "units": "6311", "nano": 840000000},
3752                                    "minimalMargin": {"currency": "rub", "units": "3155", "nano": 920000000},
3753                                    "fundsSufficiencyLevel": {"units": "1", "nano": 280000000},
3754                                    "amountOfMissingFunds": {"currency": "rub", "units": "-863", "nano": -720000000}}`.
3755        """
3756        if accountId is None or not accountId:
3757            if self.accountId is None or not self.accountId:
3758                uLogger.error("Variable `accountId` must be defined for using this method!")
3759                raise Exception("Account ID required")
3760
3761            else:
3762                accountId = self.accountId  # use `self.accountId` (main ID) by default
3763
3764        uLogger.debug("Requesting margin calculation for accountId [{}]. Wait, please...".format(accountId))
3765
3766        self.body = str({"accountId": accountId})
3767        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetMarginAttributes"
3768        rawMargin = self.SendAPIRequest(portfolioURL, reqType="POST")
3769
3770        if rawMargin == {"code": 3, "message": "account margin status is disabled", "description": "30051"}:
3771            uLogger.debug("Server response: margin status is disabled for current accountId [{}]".format(accountId))
3772            rawMargin = {}
3773
3774        else:
3775            uLogger.debug("Records with margin calculation for accountId [{}] successfully received".format(accountId))
3776
3777        return rawMargin
3778
3779    def RequestTariffLimits(self) -> dict:
3780        """
3781        Method for requesting limits of current tariff (connections, API methods etc.) of current user detected by `token`.
3782
3783        See also:
3784        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetUserTariff
3785        - What does fields in tariff mean: https://tinkoff.github.io/investAPI/users/#getusertariffrequest
3786        - Unary limit: https://tinkoff.github.io/investAPI/users/#unarylimit
3787        - Stream limit: https://tinkoff.github.io/investAPI/users/#streamlimit
3788        - `OverviewUserInfo()` method
3789
3790        :return: dict with raw data from server that contains limits of current tariff. Example of dict:
3791                 `{"unaryLimits": [{"limitPerMinute": 0, "methods": ["methods", "methods"]}, ...],
3792                   "streamLimits": [{"streams": ["streams", "streams"], "limit": 6}, ...]}`.
3793        """
3794        uLogger.debug("Requesting limits of current tariff. Wait, please...")
3795
3796        self.body = str({})
3797        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetUserTariff"
3798        rawTariffLimits = self.SendAPIRequest(portfolioURL, reqType="POST")
3799
3800        uLogger.debug("Records with limits of current tariff successfully received")
3801
3802        return rawTariffLimits
3803
3804    def RequestBondCoupons(self, iJSON: dict) -> dict:
3805        """
3806        Requesting bond payment calendar from official placement date to maturity date. If these dates are unknown
3807        then requesting dates `"from": "1970-01-01T00:00:00.000Z"` and `"to": "2099-12-31T23:59:59.000Z"`.
3808        All dates are in UTC timezone.
3809
3810        REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_GetBondCoupons
3811        Documentation:
3812        - request: https://tinkoff.github.io/investAPI/instruments/#getbondcouponsrequest
3813        - response: https://tinkoff.github.io/investAPI/instruments/#coupon
3814
3815        See also: `ExtendBondsData()`.
3816
3817        :param iJSON: raw json data of a bond from broker server, example `iJSON = self.iList["Bonds"][self.ticker]`
3818                      If raw iJSON is not data of bond then server returns an error [400] with message:
3819                      `{"code": 3, "message": "instrument type is not bond", "description": "30048"}`.
3820        :return: dictionary with bond payment calendar. Response example
3821                 `{"events": [{"figi": "TCS00A101YV8", "couponDate": "2023-07-26T00:00:00Z", "couponNumber": "12",
3822                   "fixDate": "2023-07-25T00:00:00Z", "payOneBond": {"currency": "rub", "units": "7", "nano": 170000000},
3823                   "couponType": "COUPON_TYPE_CONSTANT", "couponStartDate": "2023-04-26T00:00:00Z",
3824                   "couponEndDate": "2023-07-26T00:00:00Z", "couponPeriod": 91}, {...}, ...]}`
3825        """
3826        if iJSON["figi"] is None or not iJSON["figi"]:
3827            uLogger.error("FIGI must be defined for using this method!")
3828            raise Exception("FIGI required")
3829
3830        startDate = iJSON["placementDate"] if "placementDate" in iJSON.keys() else "1970-01-01T00:00:00.000Z"
3831        endDate = iJSON["maturityDate"] if "maturityDate" in iJSON.keys() else "2099-12-31T23:59:59.000Z"
3832
3833        uLogger.debug("Requesting bond payment calendar, {}FIGI: [{}], from: [{}], to: [{}]. Wait, please...".format(
3834            "ticker: [{}], ".format(iJSON["ticker"]) if "ticker" in iJSON.keys() else "",
3835            self.figi,
3836            startDate,
3837            endDate,
3838        ))
3839
3840        self.body = str({"figi": iJSON["figi"], "from": startDate, "to": endDate})
3841        calendarURL = self.server + r"/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetBondCoupons"
3842        calendar = self.SendAPIRequest(calendarURL, reqType="POST", debug=False)
3843
3844        if calendar == {"code": 3, "message": "instrument type is not bond", "description": "30048"}:
3845            uLogger.warning("Instrument type is not bond!")
3846
3847        else:
3848            uLogger.debug("Records about bond payment calendar successfully received")
3849
3850        return calendar
3851
3852    def ExtendBondsData(self, instruments: list[str], xlsx: bool = False) -> pd.DataFrame:
3853        """
3854        Requests jsons with raw bonds data for every ticker or FIGI in instruments list and transform it to the wider
3855        Pandas DataFrame with more information about bonds: main info, current prices, bond payment calendar,
3856        coupon yields, current yields and some statistics etc.
3857
3858        WARNING! This is too long operation if a lot of bonds requested from broker server.
3859
3860        See also: `ShowInstrumentInfo()`, `CreateBondsCalendar()`, `ShowBondsCalendar()`, `RequestBondCoupons()`.
3861
3862        :param instruments: list of strings with tickers or FIGIs.
3863        :param xlsx: if True then also exports Pandas DataFrame to xlsx-file `bondsXLSXFile`, default `ext-bonds.xlsx`,
3864                     for further used by data scientists or stock analytics.
3865        :return: wider Pandas DataFrame with more full and calculated data about bonds, than raw response from broker.
3866                 In XLSX-file and Pandas DataFrame fields mean:
3867                 - main info about bond: https://tinkoff.github.io/investAPI/instruments/#bond
3868                 - info about coupon: https://tinkoff.github.io/investAPI/instruments/#coupon
3869        """
3870        if instruments is None or not instruments:
3871            uLogger.error("List of tickers or FIGIs must be defined for using this method!")
3872            raise Exception("Ticker or FIGI required")
3873
3874        if isinstance(instruments, str):
3875            instruments = [instruments]
3876
3877        uniqueInstruments = self.GetUniqueFIGIs(instruments)
3878
3879        uLogger.debug("Requesting raw bonds calendar from server, transforming and extending it. Wait, please...")
3880
3881        iCount = len(uniqueInstruments)
3882        tooLong = iCount >= 20
3883        if tooLong:
3884            uLogger.warning("You requested a lot of bonds! Operation will takes more time. Wait, please...")
3885
3886        bonds = None
3887        for i, self.figi in enumerate(uniqueInstruments):
3888            instrument = self.SearchByFIGI(requestPrice=False)  # raw data about instrument from server
3889
3890            if "type" in instrument.keys() and instrument["type"] == "Bonds":
3891                # raw bond data from server where fields mean: https://tinkoff.github.io/investAPI/instruments/#bond
3892                rawBond = self.SearchByFIGI(requestPrice=True)
3893
3894                # Widen raw data with UTC current time (iData["actualDateTime"]):
3895                actualDate = datetime.now(tzutc())
3896                iData = {"actualDateTime": actualDate.strftime(TKS_DATE_TIME_FORMAT)} | rawBond
3897
3898                # Widen raw data with bond payment calendar (iData["rawCalendar"]):
3899                iData = iData | {"rawCalendar": self.RequestBondCoupons(iJSON=iData)}
3900
3901                # Replace some values with human-readable:
3902                iData["nominalCurrency"] = iData["nominal"]["currency"]
3903                iData["nominal"] = NanoToFloat(iData["nominal"]["units"], iData["nominal"]["nano"])
3904                iData["placementPrice"] = NanoToFloat(iData["placementPrice"]["units"], iData["placementPrice"]["nano"])
3905                iData["aciCurrency"] = iData["aciValue"]["currency"]
3906                iData["aciValue"] = NanoToFloat(iData["aciValue"]["units"], iData["aciValue"]["nano"])
3907                iData["issueSize"] = int(iData["issueSize"])
3908                iData["issueSizePlan"] = int(iData["issueSizePlan"])
3909                iData["tradingStatus"] = TKS_TRADING_STATUSES[iData["tradingStatus"]]
3910                iData["step"] = iData["step"] if "step" in iData.keys() else 0
3911                iData["realExchange"] = TKS_REAL_EXCHANGES[iData["realExchange"]]
3912                iData["klong"] = NanoToFloat(iData["klong"]["units"], iData["klong"]["nano"]) if "klong" in iData.keys() else 0
3913                iData["kshort"] = NanoToFloat(iData["kshort"]["units"], iData["kshort"]["nano"]) if "kshort" in iData.keys() else 0
3914                iData["dlong"] = NanoToFloat(iData["dlong"]["units"], iData["dlong"]["nano"]) if "dlong" in iData.keys() else 0
3915                iData["dshort"] = NanoToFloat(iData["dshort"]["units"], iData["dshort"]["nano"]) if "dshort" in iData.keys() else 0
3916                iData["dlongMin"] = NanoToFloat(iData["dlongMin"]["units"], iData["dlongMin"]["nano"]) if "dlongMin" in iData.keys() else 0
3917                iData["dshortMin"] = NanoToFloat(iData["dshortMin"]["units"], iData["dshortMin"]["nano"]) if "dshortMin" in iData.keys() else 0
3918
3919                # Widen raw data with price fields from `currentPrice` values (all prices are actual at `actualDateTime` date):
3920                iData["limitUpPercent"] = iData["currentPrice"]["limitUp"]  # max price on current day in percents of nominal
3921                iData["limitDownPercent"] = iData["currentPrice"]["limitDown"]  # min price on current day in percents of nominal
3922                iData["lastPricePercent"] = iData["currentPrice"]["lastPrice"]  # last price on market in percents of nominal
3923                iData["closePricePercent"] = iData["currentPrice"]["closePrice"]  # previous day close in percents of nominal
3924                iData["changes"] = iData["currentPrice"]["changes"]  # this is percent of changes between `currentPrice` and `lastPrice`
3925                iData["limitUp"] = iData["limitUpPercent"] * iData["nominal"] / 100  # max price on current day is `limitUpPercent` * `nominal`
3926                iData["limitDown"] = iData["limitDownPercent"] * iData["nominal"] / 100  # min price on current day is `limitDownPercent` * `nominal`
3927                iData["lastPrice"] = iData["lastPricePercent"] * iData["nominal"] / 100  # last price on market is `lastPricePercent` * `nominal`
3928                iData["closePrice"] = iData["closePricePercent"] * iData["nominal"] / 100  # previous day close is `closePricePercent` * `nominal`
3929                iData["changesDelta"] = iData["lastPrice"] - iData["closePrice"]  # this is delta between last deal price and last close
3930
3931                # Widen raw data with calendar data from `rawCalendar` values:
3932                calendarData = []
3933                for item in iData["rawCalendar"]["events"]:
3934                    calendarData.append({
3935                        "couponDate": item["couponDate"],
3936                        "couponNumber": int(item["couponNumber"]),
3937                        "fixDate": item["fixDate"] if "fixDate" in item.keys() else "",
3938                        "payCurrency": item["payOneBond"]["currency"],
3939                        "payOneBond": NanoToFloat(item["payOneBond"]["units"], item["payOneBond"]["nano"]),
3940                        "couponType": TKS_COUPON_TYPES[item["couponType"]],
3941                        "couponStartDate": item["couponStartDate"],
3942                        "couponEndDate": item["couponEndDate"],
3943                        "couponPeriod": item["couponPeriod"],
3944                    })
3945
3946                # if maturity date is unknown then uses the latest date in bond payment calendar for it:
3947                if "maturityDate" not in iData.keys():
3948                    iData["maturityDate"] = datetime.strptime(calendarData[0]["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_DATE_TIME_FORMAT) if calendarData else ""
3949
3950                # Widen raw data with Coupon Rate.
3951                # This is sum of all coupon payments divided on nominal price and expire days sum and then multiple on 365 days and 100%:
3952                iData["sumCoupons"] = sum([coupon["payOneBond"] for coupon in calendarData])
3953                iData["periodDays"] = sum([coupon["couponPeriod"] for coupon in calendarData])
3954                iData["couponsYield"] = 100 * 365 * (iData["sumCoupons"] / iData["nominal"]) / iData["periodDays"] if iData["nominal"] != 0 and iData["periodDays"] != 0 else 0.
3955
3956                # Widen raw data with Yield to Maturity (YTM) on current date.
3957                # This is sum of all stayed coupons to maturity minus ACI and divided on current bond price and then multiple on stayed days and 100%:
3958                maturityDate = datetime.strptime(iData["maturityDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()) if iData["maturityDate"] else None
3959                iData["daysToMaturity"] = (maturityDate - actualDate).days if iData["maturityDate"] else None
3960                iData["sumLastCoupons"] = sum([coupon["payOneBond"] for coupon in calendarData if datetime.strptime(coupon["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()) > actualDate])
3961                iData["lastPayments"] = iData["sumLastCoupons"] - iData["aciValue"]  # sum of all last coupons minus current ACI value
3962                iData["currentYield"] = 100 * 365 * (iData["lastPayments"] / iData["lastPrice"]) / iData["daysToMaturity"] if iData["lastPrice"] != 0 and iData["daysToMaturity"] != 0 else 0.
3963
3964                iData["calendar"] = calendarData  # adds calendar at the end
3965
3966                # Remove not used data:
3967                iData.pop("uid")
3968                iData.pop("positionUid")
3969                iData.pop("currentPrice")
3970                iData.pop("rawCalendar")
3971
3972                colNames = list(iData.keys())
3973                if bonds is None:
3974                    bonds = pd.DataFrame(data=pd.DataFrame.from_records(data=[iData], columns=colNames))
3975
3976                else:
3977                    bonds = pd.concat([bonds, pd.DataFrame.from_records(data=[iData], columns=colNames)], axis=0, ignore_index=True)
3978
3979            else:
3980                uLogger.warning("Instrument with ticker [{}] and FIGI [{}] is not a bond!".format(instrument["ticker"], instrument["figi"]))
3981
3982            processed = round(100 * (i + 1) / iCount, 1)
3983            if tooLong and processed % 5 == 0:
3984                uLogger.info("{}% processed [{} / {}]...".format(round(processed), i + 1, iCount))
3985
3986            else:
3987                uLogger.debug("{}% bonds processed [{} / {}]...".format(processed, i + 1, iCount))
3988
3989        bonds.index = bonds["ticker"].tolist()  # replace indexes with ticker names
3990
3991        # Saving bonds from Pandas DataFrame to XLSX sheet:
3992        if xlsx and self.bondsXLSXFile:
3993            with pd.ExcelWriter(
3994                    path=self.bondsXLSXFile,
3995                    date_format=TKS_DATE_FORMAT,
3996                    datetime_format=TKS_DATE_TIME_FORMAT,
3997                    mode="w",
3998            ) as writer:
3999                bonds.to_excel(
4000                    writer,
4001                    sheet_name="Extended bonds data",
4002                    index=True,
4003                    encoding="UTF-8",
4004                    freeze_panes=(1, 1),
4005                )  # saving as XLSX-file with freeze first row and column as headers
4006
4007            uLogger.info("XLSX-file with extended bonds data for further used by data scientists or stock analytics: [{}]".format(os.path.abspath(self.bondsXLSXFile)))
4008
4009        return bonds
4010
4011    def CreateBondsCalendar(self, extBonds: pd.DataFrame, xlsx: bool = False) -> pd.DataFrame:
4012        """
4013        Creates bond payments calendar as Pandas DataFrame, and also save it to the XLSX-file, `calendar.xlsx` by default.
4014
4015        WARNING! This is too long operation if a lot of bonds requested from broker server.
4016
4017        See also: `ShowBondsCalendar()`, `ExtendBondsData()`.
4018
4019        :param extBonds: Pandas DataFrame object returns by `ExtendBondsData()` method and contains
4020                        extended information about bonds: main info, current prices, bond payment calendar,
4021                        coupon yields, current yields and some statistics etc.
4022                        If this parameter is `None` then used `figi` or `ticker` as bond name and then calculate `ExtendBondsData()`.
4023        :param xlsx: if True then also exports Pandas DataFrame to file `calendarFile` + `".xlsx"`, `calendar.xlsx` by default,
4024                     for further used by data scientists or stock analytics.
4025        :return: Pandas DataFrame with only bond payments calendar data. Fields mean: https://tinkoff.github.io/investAPI/instruments/#coupon
4026        """
4027        if extBonds is None or not isinstance(extBonds, pd.DataFrame) or extBonds.empty:
4028            extBonds = self.ExtendBondsData(instruments=[self.figi, self.ticker], xlsx=False)
4029
4030        uLogger.debug("Generating bond payments calendar data. Wait, please...")
4031
4032        colNames = ["Paid", "Payment date", "FIGI", "Ticker", "Name", "No.", "Value", "Currency", "Coupon type", "Period", "End registry date", "Coupon start date", "Coupon end date"]
4033        colID = ["paid", "couponDate", "figi", "ticker", "name", "couponNumber", "payOneBond", "payCurrency", "couponType", "couponPeriod", "fixDate", "couponStartDate", "couponEndDate"]
4034        calendar = None
4035        for bond in extBonds.iterrows():
4036            for item in bond[1]["calendar"]:
4037                cData = {
4038                    "paid": datetime.now(tzutc()) > datetime.strptime(item["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()),
4039                    "couponDate": item["couponDate"],
4040                    "figi": bond[1]["figi"],
4041                    "ticker": bond[1]["ticker"],
4042                    "name": bond[1]["name"],
4043                    "couponNumber": item["couponNumber"],
4044                    "payOneBond": item["payOneBond"],
4045                    "payCurrency": item["payCurrency"],
4046                    "couponType": item["couponType"],
4047                    "couponPeriod": item["couponPeriod"],
4048                    "fixDate": item["fixDate"],
4049                    "couponStartDate": item["couponStartDate"],
4050                    "couponEndDate": item["couponEndDate"],
4051                }
4052
4053                if calendar is None:
4054                    calendar = pd.DataFrame(data=pd.DataFrame.from_records(data=[cData], columns=colID))
4055
4056                else:
4057                    calendar = pd.concat([calendar, pd.DataFrame.from_records(data=[cData], columns=colID)], axis=0, ignore_index=True)
4058
4059        calendar = calendar.sort_values(by=["couponDate"], axis=0, ascending=True)  # sort all payments for all bonds by payment date
4060
4061        # Saving calendar from Pandas DataFrame to XLSX sheet:
4062        if xlsx:
4063            xlsxCalendarFile = self.calendarFile.replace(".md", ".xlsx") if self.calendarFile.endswith(".md") else self.calendarFile + ".xlsx"
4064
4065            with pd.ExcelWriter(
4066                    path=xlsxCalendarFile,
4067                    date_format=TKS_DATE_FORMAT,
4068                    datetime_format=TKS_DATE_TIME_FORMAT,
4069                    mode="w",
4070            ) as writer:
4071                humanReadable = calendar.copy(deep=True)
4072                humanReadable["couponDate"] = humanReadable["couponDate"].apply(lambda x: x.split("T")[0])
4073                humanReadable["fixDate"] = humanReadable["fixDate"].apply(lambda x: x.split("T")[0])
4074                humanReadable["couponStartDate"] = humanReadable["couponStartDate"].apply(lambda x: x.split("T")[0])
4075                humanReadable["couponEndDate"] = humanReadable["couponEndDate"].apply(lambda x: x.split("T")[0])
4076                humanReadable.columns = colNames  # human-readable column names
4077
4078                humanReadable.to_excel(
4079                    writer,
4080                    sheet_name="Bond payments calendar",
4081                    index=False,
4082                    encoding="UTF-8",
4083                    freeze_panes=(1, 2),
4084                )  # saving as XLSX-file with freeze first row and column as headers
4085
4086                del humanReadable  # release df in memory
4087
4088            uLogger.info("XLSX-file with bond payments calendar for further used by data scientists or stock analytics: [{}]".format(os.path.abspath(xlsxCalendarFile)))
4089
4090        return calendar
4091
4092    def ShowBondsCalendar(self, extBonds: pd.DataFrame, show: bool = True) -> str:
4093        """
4094        Show bond payments calendar as a table. One row in input `bonds` dataframe contains one bond.
4095        Also, creates Markdown file with calendar data, `calendar.md` by default.
4096
4097        See also: `ShowInstrumentInfo()`, `RequestBondCoupons()`, `CreateBondsCalendar()` and `ExtendBondsData()`.
4098
4099        :param extBonds: Pandas DataFrame object returns by `ExtendBondsData()` method and contains
4100                        extended information about bonds: main info, current prices, bond payment calendar,
4101                        coupon yields, current yields and some statistics etc.
4102                        If this parameter is `None` then used `figi` or `ticker` as bond name and then calculate `ExtendBondsData()`.
4103        :param show: if `True` then also printing bonds payment calendar to the console,
4104                     otherwise save to file `calendarFile` only. `False` by default.
4105        :return: multilines text in Markdown format with bonds payment calendar as a table.
4106        """
4107        if extBonds is None or not isinstance(extBonds, pd.DataFrame) or extBonds.empty:
4108            extBonds = self.ExtendBondsData(instruments=[self.figi, self.ticker], xlsx=False)
4109
4110        infoText = "# Bond payments calendar\n\n"
4111
4112        calendar = self.CreateBondsCalendar(extBonds, xlsx=True)  # generate Pandas DataFrame with full calendar data
4113
4114        if not calendar.empty:
4115            splitLine = "|       |                 |              |              |     |               |           |        |                   |\n"
4116
4117            info = [
4118                "| Paid  | Payment date    | FIGI         | Ticker       | No. | Value         | Type      | Period | End registry date |\n",
4119                "|-------|-----------------|--------------|--------------|-----|---------------|-----------|--------|-------------------|\n",
4120            ]
4121
4122            newMonth = False
4123            notOneBond = calendar["figi"].nunique() > 1
4124            for i, bond in enumerate(calendar.iterrows()):
4125                if newMonth and notOneBond:
4126                    info.append(splitLine)
4127
4128                info.append(
4129                    "| {:<5} | {:<15} | {:<12} | {:<12} | {:<3} | {:<13} | {:<9} | {:<6} | {:<17} |\n".format(
4130                        "  √" if bond[1]["paid"] else "  —",
4131                        bond[1]["couponDate"].split("T")[0],
4132                        bond[1]["figi"],
4133                        bond[1]["ticker"],
4134                        bond[1]["couponNumber"],
4135                        "{} {}".format(
4136                            "{}".format(round(bond[1]["payOneBond"], 6)).rstrip("0").rstrip("."),
4137                            bond[1]["payCurrency"],
4138                        ),
4139                        bond[1]["couponType"],
4140                        bond[1]["couponPeriod"],
4141                        bond[1]["fixDate"].split("T")[0],
4142                    )
4143                )
4144
4145                if i < len(calendar.values) - 1:
4146                    curDate = datetime.strptime(bond[1]["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc())
4147                    nextDate = datetime.strptime(calendar["couponDate"].values[i + 1], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc())
4148                    newMonth = False if curDate.month == nextDate.month else True
4149
4150                else:
4151                    newMonth = False
4152
4153            infoText += "".join(info)
4154
4155            if show:
4156                uLogger.info("{}".format(infoText))
4157
4158            if self.calendarFile is not None:
4159                with open(self.calendarFile, "w", encoding="UTF-8") as fH:
4160                    fH.write(infoText)
4161
4162                uLogger.info("Bond payment calendar was saved to file: [{}]".format(os.path.abspath(self.calendarFile)))
4163
4164        else:
4165            infoText += "No data\n"
4166
4167        return infoText
4168
4169    def OverviewAccounts(self, show: bool = False) -> dict:
4170        """
4171        Method for parsing and show simple table with all available user accounts.
4172
4173        See also: `RequestAccounts()` and `OverviewUserInfo()` methods.
4174
4175        :param show: if `False` then only dictionary with accounts data returns, if `True` then also print it to log.
4176        :return: dict with parsed accounts data received from `RequestAccounts()` method. Example of dict:
4177                 `view = {"rawAccounts": {rawAccounts from RequestAccounts() method...},
4178                          "stat": {"accountId string": {"type": "Tinkoff brokerage account", "name": "Test - 1",
4179                                                        "status": "Opened and active account", "opened": "2018-05-23 00:00:00",
4180                                                        "closed": "—", "access": "Full access" }, ...}}`
4181        """
4182        rawAccounts = self.RequestAccounts()  # Raw responses with accounts
4183
4184        # This is an array of dict with user accounts, its `accountId`s and some parsed data:
4185        accounts = {
4186            item["id"]: {
4187                "type": TKS_ACCOUNT_TYPES[item["type"]],
4188                "name": item["name"],
4189                "status": TKS_ACCOUNT_STATUSES[item["status"]],
4190                "opened": datetime.strptime(item["openedDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
4191                "closed": datetime.strptime(item["closedDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT) if item["closedDate"] != "1970-01-01T00:00:00Z" else "—",
4192                "access": TKS_ACCESS_LEVELS[item["accessLevel"]],
4193            } for item in rawAccounts["accounts"]
4194        }
4195
4196        # Raw and parsed data with some fields replaced in "stat" section:
4197        view = {
4198            "rawAccounts": rawAccounts,
4199            "stat": accounts,
4200        }
4201
4202        # --- Prepare simple text table with only accounts data in human-readable format:
4203        if show:
4204            info = [
4205                "# User accounts\n\n",
4206                "* **Actual date:** [{} UTC]\n\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
4207                "| Account ID   | Type                      | Status                    | Name                           |\n",
4208                "|--------------|---------------------------|---------------------------|--------------------------------|\n",
4209            ]
4210
4211            for account in view["stat"].keys():
4212                info.extend([
4213                    "| {:<12} | {:<25} | {:<25} | {:<30} |\n".format(
4214                        account,
4215                        view["stat"][account]["type"],
4216                        view["stat"][account]["status"],
4217                        view["stat"][account]["name"],
4218                    )
4219                ])
4220
4221            infoText = "".join(info)
4222
4223            uLogger.info(infoText)
4224
4225            if self.userAccountsFile:
4226                with open(self.userAccountsFile, "w", encoding="UTF-8") as fH:
4227                    fH.write(infoText)
4228
4229                uLogger.info("User accounts were saved to file: [{}]".format(os.path.abspath(self.userAccountsFile)))
4230
4231        return view
4232
4233    def OverviewUserInfo(self, show: bool = False) -> dict:
4234        """
4235        Method for parsing and show all available user's data (`accountId`s, common user information, margin status and tariff connections limit).
4236
4237        See also: `OverviewAccounts()`, `RequestAccounts()`, `RequestUserInfo()`, `RequestMarginStatus()` and `RequestTariffLimits()` methods.
4238
4239        :param show: if `False` then only dictionary returns, if `True` then also print user's data to log.
4240        :return: dict with raw parsed data from server and some calculated statistics about it.
4241        """
4242        rawUserInfo = self.RequestUserInfo()  # Raw response with common user info
4243        overviewAccount = self.OverviewAccounts(show=False)  # Raw and parsed accounts data
4244        rawAccounts = overviewAccount["rawAccounts"]  # Raw response with user accounts data
4245        accounts = overviewAccount["stat"]  # Dict with only statistics about user accounts
4246        rawMargins = {account: self.RequestMarginStatus(accountId=account) for account in accounts.keys()}  # Raw response with margin calculation for every account ID
4247        rawTariffLimits = self.RequestTariffLimits()  # Raw response with limits of current tariff
4248
4249        # This is dict with parsed common user data:
4250        userInfo = {
4251            "premium": "Yes" if rawUserInfo["premStatus"] else "No",
4252            "qualified": "Yes" if rawUserInfo["qualStatus"] else "No",
4253            "allowed": [TKS_QUALIFIED_TYPES[item] for item in rawUserInfo["qualifiedForWorkWith"]],
4254            "tariff": rawUserInfo["tariff"],
4255        }
4256
4257        # This is an array of dict with parsed margin statuses for every account IDs:
4258        margins = {}
4259        for accountId in accounts.keys():
4260            if rawMargins[accountId]:
4261                margins[accountId] = {
4262                    "currency": rawMargins[accountId]["liquidPortfolio"]["currency"],
4263                    "liquid": NanoToFloat(rawMargins[accountId]["liquidPortfolio"]["units"], rawMargins[accountId]["liquidPortfolio"]["nano"]),
4264                    "start": NanoToFloat(rawMargins[accountId]["startingMargin"]["units"], rawMargins[accountId]["startingMargin"]["nano"]),
4265                    "min": NanoToFloat(rawMargins[accountId]["minimalMargin"]["units"], rawMargins[accountId]["minimalMargin"]["nano"]),
4266                    "level": NanoToFloat(rawMargins[accountId]["fundsSufficiencyLevel"]["units"], rawMargins[accountId]["fundsSufficiencyLevel"]["nano"]),
4267                    "missing": NanoToFloat(rawMargins[accountId]["amountOfMissingFunds"]["units"], rawMargins[accountId]["amountOfMissingFunds"]["nano"]),
4268                }
4269
4270            else:
4271                margins[accountId] = {}  # Server response: margin status is disabled for current accountId
4272
4273        unary = {}  # unary-connection limits
4274        for item in rawTariffLimits["unaryLimits"]:
4275            if item["limitPerMinute"] in unary.keys():
4276                unary[item["limitPerMinute"]].extend(item["methods"])
4277
4278            else:
4279                unary[item["limitPerMinute"]] = item["methods"]
4280
4281        stream = {}  # stream-connection limits
4282        for item in rawTariffLimits["streamLimits"]:
4283            if item["limit"] in stream.keys():
4284                stream[item["limit"]].extend(item["streams"])
4285
4286            else:
4287                stream[item["limit"]] = item["streams"]
4288
4289        # This is dict with parsed limits of current tariff (connections, API methods etc.):
4290        limits = {
4291            "unary": unary,
4292            "stream": stream,
4293        }
4294
4295        # Raw and parsed data as an output result:
4296        view = {
4297            "rawUserInfo": rawUserInfo,
4298            "rawAccounts": rawAccounts,
4299            "rawMargins": rawMargins,
4300            "rawTariffLimits": rawTariffLimits,
4301            "stat": {
4302                "userInfo": userInfo,
4303                "accounts": accounts,
4304                "margins": margins,
4305                "limits": limits,
4306            },
4307        }
4308
4309        # --- Prepare text table with user information in human-readable format:
4310        if show:
4311            info = [
4312                "# Full user information\n\n",
4313                "* **Actual date:** [{} UTC]\n\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
4314                "## Common information\n\n",
4315                "* **Qualified user:** {}\n".format(view["stat"]["userInfo"]["qualified"]),
4316                "* **Tariff name:** {}\n".format(view["stat"]["userInfo"]["tariff"]),
4317                "* **Premium user:** {}\n".format(view["stat"]["userInfo"]["premium"]),
4318                "* **Allowed to work with instruments:**\n{}\n".format("".join(["  - {}\n".format(item) for item in view["stat"]["userInfo"]["allowed"]])),
4319                "\n## User accounts\n\n",
4320            ]
4321
4322            for account in view["stat"]["accounts"].keys():
4323                info.extend([
4324                    "### ID: [{}]\n\n".format(account),
4325                    "| Parameters           | Values                                                       |\n",
4326                    "|----------------------|--------------------------------------------------------------|\n",
4327                    "| Account type:        | {:<60} |\n".format(view["stat"]["accounts"][account]["type"]),
4328                    "| Account name:        | {:<60} |\n".format(view["stat"]["accounts"][account]["name"]),
4329                    "| Account status:      | {:<60} |\n".format(view["stat"]["accounts"][account]["status"]),
4330                    "| Access level:        | {:<60} |\n".format(view["stat"]["accounts"][account]["access"]),
4331                    "| Date opened:         | {:<60} |\n".format(view["stat"]["accounts"][account]["opened"]),
4332                    "| Date closed:         | {:<60} |\n".format(view["stat"]["accounts"][account]["closed"]),
4333                ])
4334
4335                if margins[account]:
4336                    info.extend([
4337                        "| Margin status:       | Enabled                                                      |\n",
4338                        "| - Liquid portfolio:  | {:<60} |\n".format("{} {}".format(margins[account]["liquid"], margins[account]["currency"])),
4339                        "| - Margin starting:   | {:<60} |\n".format("{} {}".format(margins[account]["start"], margins[account]["currency"])),
4340                        "| - Margin minimum:    | {:<60} |\n".format("{} {}".format(margins[account]["min"], margins[account]["currency"])),
4341                        "| - Sufficiency level: | {:<60} |\n".format("{:.2f} ({:.2f}%)".format(margins[account]["level"], margins[account]["level"] * 100)),
4342                        "| - Missing funds:     | {:<60} |\n\n".format("{} {}".format(margins[account]["missing"], margins[account]["currency"])),
4343                    ])
4344
4345                else:
4346                    info.append("| Margin status:       | Disabled                                                     |\n\n")
4347
4348            info.extend([
4349                "\n## Current user tariff limits\n",
4350                "\nSee also:\n",
4351                "* Tinkoff limit policy: https://tinkoff.github.io/investAPI/limits/\n",
4352                "* Tinkoff Invest API: https://tinkoff.github.io/investAPI/\n",
4353                "  - More about REST API requests: https://tinkoff.github.io/investAPI/swagger-ui/\n",
4354                "  - More about gRPC requests for stream connections: https://tinkoff.github.io/investAPI/grpc/\n",
4355                "\n### Unary limits\n",
4356            ])
4357
4358            if unary:
4359                for key, values in sorted(unary.items()):
4360                    info.append("\n* Max requests per minute: {}\n".format(key))
4361
4362                    for value in values:
4363                        info.append("  - {}\n".format(value))
4364
4365            else:
4366                info.append("\nNot available\n")
4367
4368            info.append("\n### Stream limits\n")
4369
4370            if stream:
4371                for key, values in sorted(stream.items()):
4372                    info.append("\n* Max stream connections: {}\n".format(key))
4373
4374                    for value in values:
4375                        info.append("  - {}\n".format(value))
4376
4377            else:
4378                info.append("\nNot available\n")
4379
4380            infoText = "".join(info)
4381
4382            uLogger.info(infoText)
4383
4384            if self.userInfoFile:
4385                with open(self.userInfoFile, "w", encoding="UTF-8") as fH:
4386                    fH.write(infoText)
4387
4388                uLogger.info("User data was saved to file: [{}]".format(os.path.abspath(self.userInfoFile)))
4389
4390        return view
4391
4392
4393class Args:
4394    """
4395    If `Main()` function is imported as module, then this class used to convert arguments from **kwargs as object.
4396    """
4397    def __init__(self, **kwargs):
4398        self.__dict__.update(kwargs)
4399
4400    def __getattr__(self, item):
4401        return None
4402
4403
4404def ParseArgs():
4405    """This function get and parse command line keys."""
4406    parser = ArgumentParser()  # command-line string parser
4407
4408    parser.description = "TKSBrokerAPI is a trading platform for automation on Python to simplify the implementation of trading scenarios and work with Tinkoff Invest API server via the REST protocol. See examples: https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md"
4409    parser.usage = "\n/as module/ python TKSBrokerAPI.py [some options] [one command]\n/as CLI tool/ tksbrokerapi [some options] [one command]"
4410
4411    # --- options:
4412
4413    parser.add_argument("--no-cache", action="store_true", default=False, help="Option: not use local cache `dump.json`, but update raw instruments data when starting the platform. `False` by default.")
4414    parser.add_argument("--token", type=str, help="Option: Tinkoff service's api key. If not set then used environment variable `TKS_API_TOKEN`. See how to use: https://tinkoff.github.io/investAPI/token/")
4415    parser.add_argument("--account-id", type=str, default=None, help="Option: string with an user numeric account ID in Tinkoff Broker. It can be found in any broker's reports (see the contract number). Also, this variable can be set from environment variable `TKS_ACCOUNT_ID`.")
4416
4417    parser.add_argument("--ticker", "-t", type=str, help="Option: instrument's ticker, e.g. `IBM`, `YNDX`, `GOOGL` etc. Use alias for `USD000UTSTOM` simple as `USD`, `EUR_RUB__TOM` as `EUR`.")
4418    parser.add_argument("--figi", "-f", type=str, help="Option: instrument's FIGI, e.g. `BBG006L8G4H1` (for `YNDX`).")
4419
4420    parser.add_argument("--depth", type=int, default=1, help="Option: Depth of Market (DOM) can be >=1, 1 by default.")
4421    parser.add_argument("--no-cancelled", "--no-canceled", action="store_true", default=False, help="Option: remove information about cancelled operations from the deals report by the `--deals` key. `False` by default.")
4422
4423    parser.add_argument("--output", type=str, default=None, help="Option: replace default paths to output files for some commands. If `None` then used default files.")
4424
4425    parser.add_argument("--interval", type=str, default="hour", help="Option: available values are `1min`, `5min`, `15min`, `hour` and `day`. Used only with `--history` key. This is time period of one candle. Default: `hour` for every history candles.")
4426    parser.add_argument("--only-missing", action="store_true", default=False, help="Option: if history file define by `--output` key then add only last missing candles, do not request all history length. `False` by default.")
4427    parser.add_argument("--csv-sep", type=str, default=",", help="Option: separator if csv-file is used, `,` by default.")
4428
4429    parser.add_argument("--debug-level", "--verbosity", "-v", type=int, default=20, help="Option: showing STDOUT messages of minimal debug level, e.g. 10 = DEBUG, 20 = INFO, 30 = WARNING, 40 = ERROR, 50 = CRITICAL. INFO (20) by default.")
4430
4431    # --- commands:
4432
4433    parser.add_argument("--version", "--ver", action="store_true", help="Action: shows current semantic version, looks like `major.minor.buildnumber`. If TKSBrokerAPI not installed via pip, then used local build number `.dev0`.")
4434
4435    parser.add_argument("--list", "-l", action="store_true", help="Action: get and print all available instruments and some information from broker server. Also, you can define `--output` key to save list of instruments to file, default: `instruments.md`.")
4436    parser.add_argument("--list-xlsx", "-x", action="store_true", help="Action: get all available instruments from server for current account and save raw data into xlsx-file for further used by data scientists or stock analytics, default: `dump.xlsx`.")
4437    parser.add_argument("--bonds-xlsx", "-b", type=str, nargs="*", help="Action: get all available bonds if only key present or list of bonds with FIGIs or tickers and transform it to the wider Pandas DataFrame with more information about bonds: main info, current prices, bonds payment calendar, coupon yields, current yields and some statistics etc. And then export data to XLSX-file, default: `ext-bonds.xlsx` or you can change it with `--output` key. WARNING! This is too long operation if a lot of bonds requested from broker server.")
4438    parser.add_argument("--search", "-s", type=str, nargs=1, help="Action: search for an instruments by part of the name, ticker or FIGI. Also, you can define `--output` key to save results to file, default: `search-results.md`.")
4439    parser.add_argument("--info", "-i", action="store_true", help="Action: get information from broker server about instrument by it's ticker or FIGI. `--ticker` key or `--figi` key must be defined!")
4440    parser.add_argument("--calendar", "-c", type=str, nargs="*", help="Action: show bonds payment calendar as a table. Calendar build for one or more tickers or FIGIs, or for all bonds if only key present. If the `--output` key present then calendar saves to file, default: `calendar.md`. Also, created XLSX-file with bond payments calendar for further used by data scientists or stock analytics, `calendar.xlsx` by default. WARNING! This is too long operation if a lot of bonds requested from broker server.")
4441    parser.add_argument("--price", action="store_true", help="Action: show actual price list for current instrument. Also, you can use `--depth` key. `--ticker` key or `--figi` key must be defined!")
4442    parser.add_argument("--prices", "-p", type=str, nargs="+", help="Action: get and print current prices for list of given instruments (by it's tickers or by FIGIs). WARNING! This is too long operation if you request a lot of instruments! Also, you can define `--output` key to save list of prices to file, default: `prices.md`.")
4443
4444    parser.add_argument("--overview", "-o", action="store_true", help="Action: shows all open positions, orders and some statistics. Also, you can define `--output` key to save this information to file, default: `overview.md`.")
4445    parser.add_argument("--overview-digest", action="store_true", help="Action: shows a short digest of the portfolio status. Also, you can define `--output` key to save this information to file, default: `overview-digest.md`.")
4446    parser.add_argument("--overview-positions", action="store_true", help="Action: shows only open positions. Also, you can define `--output` key to save this information to file, default: `overview-positions.md`.")
4447    parser.add_argument("--overview-orders", action="store_true", help="Action: shows only sections of open limits and stop orders. Also, you can define `--output` key to save orders to file, default: `overview-orders.md`.")
4448    parser.add_argument("--overview-analytics", action="store_true", help="Action: shows only the analytics section and the distribution of the portfolio by various categories. Also, you can define `--output` key to save this information to file, default: `overview-analytics.md`.")
4449
4450    parser.add_argument("--deals", "-d", type=str, nargs="*", help="Action: show all deals between two given dates. Start day may be an integer number: -1, -2, -3 days ago. Also, you can use keywords: `today`, `yesterday` (-1), `week` (-7), `month` (-30) and `year` (-365). Dates format must be: `%%Y-%%m-%%d`, e.g. 2020-02-03. With `--no-cancelled` key information about cancelled operations will be removed from the deals report. Also, you can define `--output` key to save all deals to file, default: `deals.md`.")
4451    parser.add_argument("--history", type=str, nargs="*", help="Action: get last history candles of the current instrument defined by `--ticker` or `--figi` (FIGI id) keys. History returned between two given dates: `start` and `end`. Minimum requested date in the past is `1970-01-01`. This action may be used together with the `--render-chart` key. Also, you can define `--output` key to save history candlesticks to file.")
4452    parser.add_argument("--load-history", type=str, help="Action: try to load history candles from given csv-file as a Pandas Dataframe and print it in to the console. This action may be used together with the `--render-chart` key.")
4453    parser.add_argument("--render-chart", type=str, help="Action: render candlesticks chart. This key may only used with `--history` or `--load-history` together. Action has 1 parameter with two possible string values: `interact` (`i`) or `non-interact` (`ni`).")
4454
4455    parser.add_argument("--trade", nargs="*", help="Action: universal action to open market position for defined ticker or FIGI. You must specify 1-5 parameters: [direction `Buy` or `Sell`] [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]. See examples in readme.")
4456    parser.add_argument("--buy", nargs="*", help="Action: immediately open BUY market position at the current price for defined ticker or FIGI. You must specify 0-4 parameters: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`].")
4457    parser.add_argument("--sell", nargs="*", help="Action: immediately open SELL market position at the current price for defined ticker or FIGI. You must specify 0-4 parameters: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`].")
4458
4459    parser.add_argument("--order", nargs="*", help="Action: universal action to open limit or stop-order in any directions. You must specify 4-7 parameters: [direction `Buy` or `Sell`] [order type `Limit` or `Stop`] [lots] [target price] [maybe for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]]. See examples in readme.")
4460    parser.add_argument("--buy-limit", type=float, nargs=2, help="Action: open pending BUY limit-order (below current price). You must specify only 2 parameters: [lots] [target price] to open BUY limit-order. If you try to create `Buy` limit-order above current price then broker immediately open `Buy` market order, such as if you do simple `--buy` operation!")
4461    parser.add_argument("--sell-limit", type=float, nargs=2, help="Action: open pending SELL limit-order (above current price). You must specify only 2 parameters: [lots] [target price] to open SELL limit-order. If you try to create `Sell` limit-order below current price then broker immediately open `Sell` market order, such as if you do simple `--sell` operation!")
4462    parser.add_argument("--buy-stop", nargs="*", help="Action: open BUY stop-order. You must specify at least 2 parameters: [lots] [target price] to open BUY stop-order. In additional you can specify 3 parameters for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]. When current price will go up or down to target price value then broker opens a limit order. Stop loss order always executed by market price.")
4463    parser.add_argument("--sell-stop", nargs="*", help="Action: open SELL stop-order. You must specify at least 2 parameters: [lots] [target price] to open SELL stop-order. In additional you can specify 3 parameters for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]. When current price will go up or down to target price value then broker opens a limit order. Stop loss order always executed by market price.")
4464    # parser.add_argument("--buy-limit-order-grid", type=str, nargs="*", help="Action: open grid of pending BUY limit-orders (below current price). Parameters format: l(ots)=[L_int,...] p(rices)=[P_float,...]. Counts of values in lots and prices lists must be equals!")
4465    # parser.add_argument("--sell-limit-order-grid", type=str, nargs="*", help="Action: open grid of pending SELL limit-orders (above current price). Parameters format: l(ots)=[L_int,...] p(rices)=[P_float,...]. Counts of values in lots and prices lists must be equals!")
4466
4467    parser.add_argument("--close-order", "--cancel-order", type=str, nargs=1, help="Action: close only one order by it's `orderId` or `stopOrderId`. You can find out the meaning of these IDs using the key `--overview`.")
4468    parser.add_argument("--close-orders", "--cancel-orders", type=str, nargs="+", help="Action: close one or list of orders by it's `orderId` or `stopOrderId`. You can find out the meaning of these IDs using the key `--overview`.")
4469    parser.add_argument("--close-trade", "--cancel-trade", action="store_true", help="Action: close only one position for instrument defined by `--ticker` (high priority) or `--figi` keys, including for currencies tickers.")
4470    parser.add_argument("--close-trades", "--cancel-trades", type=str, nargs="+", help="Action: close positions for list of tickers or FIGIs, including for currencies tickers or FIGIs.")
4471    parser.add_argument("--close-all", "--cancel-all", type=str, nargs="*", help="Action: close all available (not blocked) opened trades and orders, excluding for currencies. Also you can select one or more keywords case insensitive to specify trades type: `orders`, `shares`, `bonds`, `etfs` and `futures`, but not `currencies`. Currency positions you must closes manually using `--buy`, `--sell`, `--close-trade` or `--close-trades` operations.")
4472
4473    parser.add_argument("--limits", "--withdrawal-limits", "-w", action="store_true", help="Action: show table of funds available for withdrawal for current `accountId`. You can change `accountId` with the key `--account-id`. Also, you can define `--output` key to save this information to file, default: `limits.md`.")
4474    parser.add_argument("--user-info", "-u", action="store_true", help="Action: show all available user's data (`accountId`s, common user information, margin status and tariff connections limit). Also, you can define `--output` key to save this information to file, default: `user-info.md`.")
4475    parser.add_argument("--account", "--accounts", "-a", action="store_true", help="Action: show simple table with all available user accounts. Also, you can define `--output` key to save this information to file, default: `accounts.md`.")
4476
4477    cmdArgs = parser.parse_args()
4478    return cmdArgs
4479
4480
4481def Main(**kwargs):
4482    """
4483    Main function for work with TKSBrokerAPI in the console.
4484
4485    See examples:
4486    - in english: https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md
4487    - in russian: https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README.md
4488    """
4489    args = Args(**kwargs) if kwargs else ParseArgs()  # get and parse command-line parameters or use **kwarg parameters
4490
4491    if args.debug_level:
4492        uLogger.level = 10  # always debug level by default
4493        uLogger.handlers[0].level = args.debug_level  # level for STDOUT
4494
4495    exitCode = 0
4496    start = datetime.now(tzutc())
4497    uLogger.debug(">>> TKSBrokerAPI module started at: [{}] UTC, it is [{}] local time".format(
4498        start.strftime(TKS_PRINT_DATE_TIME_FORMAT),
4499        start.astimezone(tzlocal()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
4500    ))
4501
4502    # trying to calculate full current version:
4503    buildVersion = __version__
4504    try:
4505        v = version("tksbrokerapi")
4506        buildVersion = v if v.startswith(buildVersion) else buildVersion + ".dev0"  # set version as major.minor.dev0 if run as local build or local script
4507
4508    except Exception:
4509        buildVersion = __version__ + ".dev0"  # if an errors occurred then also set version as major.minor.dev0
4510
4511    uLogger.debug("TKSBrokerAPI major.minor.build version used: [{}]".format(buildVersion))
4512    uLogger.debug("Host CPU count: [{}]".format(CPU_COUNT))
4513
4514    try:
4515        if args.version:
4516            print("TKSBrokerAPI {}".format(buildVersion))
4517            uLogger.debug("User requested current TKSBrokerAPI major.minor.build version: [{}]".format(buildVersion))
4518
4519        else:
4520            # Init class for trading with Tinkoff Broker: TODO: rename `server` to `trader`
4521            server = TinkoffBrokerServer(
4522                token=args.token,
4523                accountId=args.account_id,
4524                useCache=not args.no_cache,
4525            )
4526
4527            # --- set some options:
4528
4529            if args.ticker:
4530                if args.ticker in server.aliasesKeys:
4531                    server.ticker = server.aliases[args.ticker]  # Replace some tickers with its aliases
4532
4533                else:
4534                    server.ticker = args.ticker
4535
4536            if args.figi:
4537                server.figi = args.figi
4538
4539            if args.depth is not None:
4540                server.depth = args.depth
4541
4542            # --- do one of commands:
4543
4544            if args.list:
4545                if args.output is not None:
4546                    server.instrumentsFile = args.output
4547
4548                server.ShowInstrumentsInfo(show=True)
4549
4550            elif args.list_xlsx:
4551                server.DumpInstrumentsAsXLSX(forceUpdate=False)
4552
4553            elif args.bonds_xlsx is not None:
4554                if args.output is not None:
4555                    server.bondsXLSXFile = args.output
4556
4557                if len(args.bonds_xlsx) == 0:
4558                    server.ExtendBondsData(instruments=server.iList["Bonds"].keys(), xlsx=True)  # request bonds with all available tickers
4559
4560                else:
4561                    server.ExtendBondsData(instruments=args.bonds_xlsx, xlsx=True)  # request list of given bonds
4562
4563            elif args.search:
4564                if args.output is not None:
4565                    server.searchResultsFile = args.output
4566
4567                server.SearchInstruments(pattern=args.search[0], show=True)
4568
4569            elif args.info:
4570                if not (args.ticker or args.figi):
4571                    uLogger.error("`--ticker` key or `--figi` key is required for this operation!")
4572                    raise Exception("Ticker or FIGI required")
4573
4574                if args.output is not None:
4575                    server.infoFile = args.output
4576
4577                if args.ticker:
4578                    server.SearchByTicker(requestPrice=True, show=True, debug=False)  # show info and current prices by ticker name
4579
4580                else:
4581                    server.SearchByFIGI(requestPrice=True, show=True, debug=False)  # show info and current prices by FIGI id
4582
4583            elif args.calendar is not None:
4584                if args.output is not None:
4585                    server.calendarFile = args.output
4586
4587                if len(args.calendar) == 0:
4588                    bondsData = server.ExtendBondsData(instruments=server.iList["Bonds"].keys(), xlsx=False)  # request bonds with all available tickers
4589
4590                else:
4591                    bondsData = server.ExtendBondsData(instruments=args.calendar, xlsx=False)  # request list of given bonds
4592
4593                server.ShowBondsCalendar(extBonds=bondsData, show=True)  # shows bonds payment calendar only
4594
4595            elif args.price:
4596                if not (args.ticker or args.figi):
4597                    uLogger.error("`--ticker` key or `--figi` key is required for this operation!")
4598                    raise Exception("Ticker or FIGI required")
4599
4600                server.GetCurrentPrices(show=True)
4601
4602            elif args.prices is not None:
4603                if args.output is not None:
4604                    server.pricesFile = args.output
4605
4606                server.GetListOfPrices(instruments=args.prices, show=True)  # WARNING: too long wait for a lot of instruments prices
4607
4608            elif args.overview:
4609                if args.output is not None:
4610                    server.overviewFile = args.output
4611
4612                server.Overview(show=True, details="full")
4613
4614            elif args.overview_digest:
4615                if args.output is not None:
4616                    server.overviewDigestFile = args.output
4617
4618                server.Overview(show=True, details="digest")
4619
4620            elif args.overview_positions:
4621                if args.output is not None:
4622                    server.overviewPositionsFile = args.output
4623
4624                server.Overview(show=True, details="positions")
4625
4626            elif args.overview_orders:
4627                if args.output is not None:
4628                    server.overviewOrdersFile = args.output
4629
4630                server.Overview(show=True, details="orders")
4631
4632            elif args.overview_analytics:
4633                if args.output is not None:
4634                    server.overviewAnalyticsFile = args.output
4635
4636                server.Overview(show=True, details="analytics")
4637
4638            elif args.deals is not None:
4639                if args.output is not None:
4640                    server.reportFile = args.output
4641
4642                if 0 <= len(args.deals) < 3:
4643                    server.Deals(
4644                        start=args.deals[0] if len(args.deals) >= 1 else None,
4645                        end=args.deals[1] if len(args.deals) == 2 else None,
4646                        show=True,  # Always show deals report in console
4647                        showCancelled=not args.no_cancelled,  # If --no-cancelled key then remove cancelled operations from the deals report. False by default.
4648                    )
4649
4650                else:
4651                    uLogger.error("You must specify 0-2 parameters: [DATE_START] [DATE_END]")
4652                    raise Exception("Incorrect value")
4653
4654            elif args.history is not None:
4655                if args.output is not None:
4656                    server.historyFile = args.output
4657
4658                if 0 <= len(args.history) < 3:
4659                    dataReceived = server.History(
4660                        start=args.history[0] if len(args.history) >= 1 else None,
4661                        end=args.history[1] if len(args.history) == 2 else None,
4662                        interval="hour" if args.interval is None or not args.interval else args.interval,
4663                        onlyMissing=False if args.only_missing is None or not args.only_missing else args.only_missing,
4664                        csvSep="," if args.csv_sep is None or not args.csv_sep else args.csv_sep,
4665                        show=True,  # shows all downloaded candles in console
4666                    )
4667
4668                    if args.render_chart is not None and dataReceived is not None:
4669                        iChart = False if args.render_chart.lower() == "ni" or args.render_chart.lower() == "non-interact" else True
4670
4671                        server.ShowHistoryChart(
4672                            candles=dataReceived,
4673                            interact=iChart,
4674                            openInBrowser=False,  # False by default, to avoid issues with `permissions denied` to html-file.
4675                        )
4676
4677                else:
4678                    uLogger.error("You must specify 0-2 parameters: [DATE_START] [DATE_END]")
4679                    raise Exception("Incorrect value")
4680
4681            elif args.load_history is not None:
4682                histData = server.LoadHistory(filePath=args.load_history)  # load data from file and show history in console
4683
4684                if args.render_chart is not None and histData is not None:
4685                    iChart = False if args.render_chart.lower() == "ni" or args.render_chart.lower() == "non-interact" else True
4686                    server.ticker = os.path.basename(args.load_history)  # use filename as ticker name for PriceGenerator's chart
4687
4688                    server.ShowHistoryChart(
4689                        candles=histData,
4690                        interact=iChart,
4691                        openInBrowser=False,  # False by default, to avoid issues with `permissions denied` to html-file.
4692                    )
4693
4694            elif args.trade is not None:
4695                if 1 <= len(args.trade) <= 5:
4696                    server.Trade(
4697                        operation=args.trade[0],
4698                        lots=int(args.trade[1]) if len(args.trade) >= 2 else 1,
4699                        tp=float(args.trade[2]) if len(args.trade) >= 3 else 0.,
4700                        sl=float(args.trade[3]) if len(args.trade) >= 4 else 0.,
4701                        expDate=args.trade[4] if len(args.trade) == 5 else "Undefined",
4702                    )
4703
4704                else:
4705                    uLogger.error("You must specify 1-5 parameters to open trade: [direction `Buy` or `Sell`] [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
4706
4707            elif args.buy is not None:
4708                if 0 <= len(args.buy) <= 4:
4709                    server.Buy(
4710                        lots=int(args.buy[0]) if len(args.buy) >= 1 else 1,
4711                        tp=float(args.buy[1]) if len(args.buy) >= 2 else 0.,
4712                        sl=float(args.buy[2]) if len(args.buy) >= 3 else 0.,
4713                        expDate=args.buy[3] if len(args.buy) == 4 else "Undefined",
4714                    )
4715
4716                else:
4717                    uLogger.error("You must specify 0-4 parameters to open buy position: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
4718
4719            elif args.sell is not None:
4720                if 0 <= len(args.sell) <= 4:
4721                    server.Sell(
4722                        lots=int(args.sell[0]) if len(args.sell) >= 1 else 1,
4723                        tp=float(args.sell[1]) if len(args.sell) >= 2 else 0.,
4724                        sl=float(args.sell[2]) if len(args.sell) >= 3 else 0.,
4725                        expDate=args.sell[3] if len(args.sell) == 4 else "Undefined",
4726                    )
4727
4728                else:
4729                    uLogger.error("You must specify 0-4 parameters to open sell position: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
4730
4731            elif args.order:
4732                if 4 <= len(args.order) <= 7:
4733                    server.Order(
4734                        operation=args.order[0],
4735                        orderType=args.order[1],
4736                        lots=int(args.order[2]),
4737                        targetPrice=float(args.order[3]),
4738                        limitPrice=float(args.order[4]) if len(args.order) >= 5 else 0.,
4739                        stopType=args.order[5] if len(args.order) >= 6 else "Limit",
4740                        expDate=args.order[6] if len(args.order) == 7 else "Undefined",
4741                    )
4742
4743                else:
4744                    uLogger.error("You must specify 4-7 parameters to open order: [direction `Buy` or `Sell`] [order type `Limit` or `Stop`] [lots] [target price] [maybe for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%Y-%m-%d %H:%M:%S`]]. See: `python TKSBrokerAPI.py --help`")
4745
4746            elif args.buy_limit:
4747                server.BuyLimit(lots=int(args.buy_limit[0]), targetPrice=args.buy_limit[1])
4748
4749            elif args.sell_limit:
4750                server.SellLimit(lots=int(args.sell_limit[0]), targetPrice=args.sell_limit[1])
4751
4752            elif args.buy_stop:
4753                if 2 <= len(args.buy_stop) <= 7:
4754                    server.BuyStop(
4755                        lots=int(args.buy_stop[0]),
4756                        targetPrice=float(args.buy_stop[1]),
4757                        limitPrice=float(args.buy_stop[2]) if len(args.buy_stop) >= 3 else 0.,
4758                        stopType=args.buy_stop[3] if len(args.buy_stop) >= 4 else "Limit",
4759                        expDate=args.buy_stop[4] if len(args.buy_stop) == 5 else "Undefined",
4760                    )
4761
4762                else:
4763                    uLogger.error("You must specify 2-5 parameters for buy stop-order: [lots] [target price] [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
4764
4765            elif args.sell_stop:
4766                if 2 <= len(args.sell_stop) <= 7:
4767                    server.SellStop(
4768                        lots=int(args.sell_stop[0]),
4769                        targetPrice=float(args.sell_stop[1]),
4770                        limitPrice=float(args.sell_stop[2]) if len(args.sell_stop) >= 3 else 0.,
4771                        stopType=args.sell_stop[3] if len(args.sell_stop) >= 4 else "Limit",
4772                        expDate=args.sell_stop[4] if len(args.sell_stop) == 5 else "Undefined",
4773                    )
4774
4775                else:
4776                    uLogger.error("You must specify 2-5 parameters for sell stop-order: [lots] [target price] [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%Y-%m-%d %H:%M:%S`]. See: python TKSBrokerAPI.py --help")
4777
4778            # elif args.buy_order_grid is not None:
4779            #     # update order grid work with api v2
4780            #     if len(args.buy_order_grid) == 2:
4781            #         orderParams = server.ParseOrderParameters(operation="Buy", **dict(kw.split('=') for kw in args.buy_order_grid))
4782            #
4783            #         for order in orderParams:
4784            #             server.Order(operation="Buy", lots=order["lot"], price=order["price"])
4785            #
4786            #     else:
4787            #         uLogger.error("To open grid of pending BUY limit-orders (below current price) you must specified 2 parameters: l(ots)=[L_int,...] p(rices)=[P_float,...]. See: `python TKSBrokerAPI.py --help`")
4788            #
4789            # elif args.sell_order_grid is not None:
4790            #     # update order grid work with api v2
4791            #     if len(args.sell_order_grid) >= 2:
4792            #         orderParams = server.ParseOrderParameters(operation="Sell", **dict(kw.split('=') for kw in args.sell_order_grid))
4793            #
4794            #         for order in orderParams:
4795            #             server.Order(operation="Sell", lots=order["lot"], price=order["price"])
4796            #
4797            #     else:
4798            #         uLogger.error("To open grid of pending SELL limit-orders (above current price) you must specified 2 parameters: l(ots)=[L_int,...] p(rices)=[P_float,...]. See: `python TKSBrokerAPI.py --help`")
4799
4800            elif args.close_order is not None:
4801                server.CloseOrders(args.close_order)  # close only one order
4802
4803            elif args.close_orders is not None:
4804                server.CloseOrders(args.close_orders)  # close list of orders
4805
4806            elif args.close_trade:
4807                if not (args.ticker or args.figi):
4808                    uLogger.error("`--ticker` key or `--figi` key is required for this operation!")
4809                    raise Exception("Ticker or FIGI required")
4810
4811                if args.ticker:
4812                    server.CloseTrades([args.ticker])  # close only one trade by ticker (priority)
4813
4814                else:
4815                    server.CloseTrades([args.figi])  # close only one trade by FIGI
4816
4817            elif args.close_trades is not None:
4818                server.CloseTrades(args.close_trades)  # close trades for list of tickers
4819
4820            elif args.close_all is not None:
4821                server.CloseAll(*args.close_all)
4822
4823            elif args.limits:
4824                if args.output is not None:
4825                    server.withdrawalLimitsFile = args.output
4826
4827                server.OverviewLimits(show=True)
4828
4829            elif args.user_info:
4830                if args.output is not None:
4831                    server.userInfoFile = args.output
4832
4833                server.OverviewUserInfo(show=True)
4834
4835            elif args.account:
4836                if args.output is not None:
4837                    server.userAccountsFile = args.output
4838
4839                server.OverviewAccounts(show=True)
4840
4841            else:
4842                uLogger.error("There is no command to execute! One of the possible commands must be selected. See help with `--help` key.")
4843                raise Exception("There is no command to execute")
4844
4845    except Exception:
4846        trace = tb.format_exc()
4847        for e in ["socket.gaierror", "nodename nor servname provided", "or not known", "NewConnectionError", "[Errno 8]", "Failed to establish a new connection"]:
4848            if e in trace:
4849                uLogger.error("Check your Internet connection! Failed to establish connection to broker server!")
4850                break
4851
4852        uLogger.debug(trace)
4853        uLogger.debug("Please, check issues or request a new one at https://github.com/Tim55667757/TKSBrokerAPI/issues")
4854        exitCode = 255  # an error occurred, must be open a ticket for this issue
4855
4856    finally:
4857        finish = datetime.now(tzutc())
4858
4859        if exitCode == 0:
4860            uLogger.debug("All operations were finished success (summary code is 0).")
4861
4862        else:
4863            uLogger.error("An issue occurred with TKSBrokerAPI module! See full debug log in [{}] or run TKSBrokerAPI once again with the key `--debug-level 10`. Summary code: {}".format(
4864                os.path.abspath(uLog.defaultLogFile), exitCode,
4865            ))
4866
4867        uLogger.debug(">>> TKSBrokerAPI module work duration: [{}]".format(finish - start))
4868        uLogger.debug(">>> TKSBrokerAPI module finished: [{} UTC], it is [{}] local time".format(
4869            finish.strftime(TKS_PRINT_DATE_TIME_FORMAT),
4870            finish.astimezone(tzlocal()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
4871        ))
4872
4873        if not kwargs:
4874            sys.exit(exitCode)
4875
4876        else:
4877            return exitCode
4878
4879
4880if __name__ == "__main__":
4881    Main()